MAINT: backfill documentation in JsonPropertyDescription for split_st…

…ring (opensearch-project#4720) * MAINT: add documentation in JsonPropertyDescription for split_string processor Signed-off-by: George Chen <[email protected]>
JannikBrand · Jul 13, 2024 · 37b664b · 37b664b
1 parent a988177
commit 37b664b
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/...org/opensearch/dataprepper/plugins/processor/mutatestring/SplitStringProcessorConfig.java b/...org/opensearch/dataprepper/plugins/processor/mutatestring/SplitStringProcessorConfig.java
@@ -7,6 +7,7 @@
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.annotation.JsonPropertyDescription;
 import jakarta.validation.Valid;
 import jakarta.validation.constraints.NotEmpty;
 import jakarta.validation.constraints.NotNull;
@@ -20,15 +21,23 @@ public static class Entry {
 
         @NotEmpty
         @NotNull
+        @JsonPropertyDescription("The key to split.")
         private EventKey source;
 
         @JsonProperty("delimiter_regex")
+        @JsonPropertyDescription("The regex string responsible for the split. Cannot be defined at the same time as `delimiter`. " +
+                "At least `delimiter` or `delimiter_regex` must be defined.")
         private String delimiterRegex;
 
         @Size(min = 1, max = 1)
+        @JsonPropertyDescription("The separator character responsible for the split. " +
+                "Cannot be defined at the same time as `delimiter_regex`. " +
+                "At least `delimiter` or `delimiter_regex` must be defined.")
         private String delimiter;
 
         @JsonProperty("split_when")
+        @JsonPropertyDescription("Specifies under what condition the `split_string` processor should perform splitting. " +
+                "Default is no condition.")
         private String splitWhen;
 
         public EventKey getSource() {
@@ -61,6 +70,7 @@ public List<Entry> getIterativeConfig() {
         return entries;
     }
 
+    @JsonPropertyDescription("List of entries. Valid values are `source`, `delimiter`, and `delimiter_regex`.")
     private List<@Valid Entry> entries;
 
     public List<Entry> getEntries() {