[GitHub] [kafka] dajac commented on a diff in pull request #12226: KAFKA-13890: Improve documentation of `ssl.keystore.type` and `ssl.truststore.type`

[GitBox <gi...@apache.org>]

dajac commented on code in PR #12226:
URL: https://github.com/apache/kafka/pull/12226#discussion_r887615311


##########
clients/src/main/java/org/apache/kafka/common/config/SslConfigs.java:
##########
@@ -69,7 +69,7 @@ public class SslConfigs {
 
     public static final String SSL_KEYSTORE_TYPE_CONFIG = "ssl.keystore.type";
     public static final String SSL_KEYSTORE_TYPE_DOC = "The file format of the key store file. "
-            + "This is optional for client.";
+            + "This is optional for client. The currently supported values for kafka are [JKS , PKCS12, PEM].";

Review Comment:
   Our documentation generator has the ability to get the supported values from the validator. Here is an example:
   ```
   .define(LogMessageTimestampTypeProp, STRING, Defaults.LogMessageTimestampType, in("CreateTime", "LogAppendTime"), MEDIUM, LogMessageTimestampTypeDoc)
   ```
   Have you considered doing something similar here? Is there a reason not to do this?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org