From 8fac7cfe06edef6c35fb994ffc504b1b4ec9e56e Mon Sep 17 00:00:00 2001
From: Qi Chen <qchea@amazon.com>
Date: Fri, 12 Jul 2024 13:30:05 -0500
Subject: [PATCH] MAINT: backfill documentation into json description for
 truncate processor (#4726)

* MAINT: backfill documentation into json description for truncate processor

Signed-off-by: George Chen <qchea@amazon.com>
---
 .../processor/truncate/TruncateProcessorConfig.java      | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/data-prepper-plugins/truncate-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/truncate/TruncateProcessorConfig.java b/data-prepper-plugins/truncate-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/truncate/TruncateProcessorConfig.java
index 7fde949719..02c83f5773 100644
--- a/data-prepper-plugins/truncate-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/truncate/TruncateProcessorConfig.java
+++ b/data-prepper-plugins/truncate-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/truncate/TruncateProcessorConfig.java
@@ -6,6 +6,7 @@
 package org.opensearch.dataprepper.plugins.processor.truncate;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.annotation.JsonPropertyDescription;
 import jakarta.validation.constraints.NotEmpty;
 import jakarta.validation.constraints.NotNull;
 import jakarta.validation.constraints.AssertTrue; 
@@ -16,18 +17,25 @@
 public class TruncateProcessorConfig {
     public static class Entry {
         @JsonProperty("source_keys")
+        @JsonPropertyDescription("The list of source keys that will be modified by the processor. " +
+                "The default value is an empty list, which indicates that all values will be truncated.")
         private List<String> sourceKeys;
 
         @JsonProperty("start_at")
+        @JsonPropertyDescription("Where in the string value to start truncation. " +
+                "Default is `0`, which specifies to start truncation at the beginning of each key's value.")
         private Integer startAt;
 
         @JsonProperty("length")
+        @JsonPropertyDescription("The length of the string after truncation. " +
+                "When not specified, the processor will measure the length based on where the string ends.")
         private Integer length;
 
         @JsonProperty("recursive")
         private Boolean recurse = false;
 
         @JsonProperty("truncate_when")
+        @JsonPropertyDescription("A condition that, when met, determines when the truncate operation is performed.")
         private String truncateWhen;
 
         public Entry(final List<String> sourceKeys, final Integer startAt, final Integer length, final String truncateWhen, final Boolean recurse) {
@@ -77,6 +85,7 @@ public boolean isValidConfig() {
 
     @NotEmpty
     @NotNull
+    @JsonPropertyDescription("A list of entries to add to an event.")
     private List<@Valid Entry> entries;
 
     public List<Entry> getEntries() {