add better descriptions for string literal character and strict grouping

Signed-off-by: Katherine Shen <katshen@amazon.com>
shenkw1 · Jul 18, 2024 · 5c68a53 · 5c68a53
1 parent 8790785
commit 5c68a53
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/...n/java/org/opensearch/dataprepper/plugins/processor/keyvalue/KeyValueProcessorConfig.java b/...n/java/org/opensearch/dataprepper/plugins/processor/keyvalue/KeyValueProcessorConfig.java
@@ -183,12 +183,16 @@ public class KeyValueProcessorConfig {
     private String keyValueWhen;
 
     @JsonProperty("strict_grouping")
-    @JsonPropertyDescription("Specifies whether strict grouping should be enabled when the `value_grouping` " +
+    @JsonPropertyDescription("When enabled, groups with unmatched end characters yield errors. " +
+            "The event is ignored after the errors are logged. " +
+            "Specifies whether strict grouping should be enabled when the `value_grouping` " +
             "or `string_literal_character` options are used. Default is `false`.")
     private boolean strictGrouping = false;
 
     @JsonProperty("string_literal_character")
-    @JsonPropertyDescription("Can be set to either a single quotation mark (`'`) or a double quotation mark (`\"`). " +
+    @JsonPropertyDescription("When this option is used, any text contained within the specified quotation " +
+            "mark character will be ignored and excluded from key-value parsing. " +
+            "Can be set to either a single quotation mark (`'`) or a double quotation mark (`\"`). " +
             "Default is `null`.")
     @Size(min = 0, max = 1, message = "string_literal_character may only have character")
     private String stringLiteralCharacter = null;