Add comments around ConfigItemChanges methods

Signed-off-by: Peter Nied <petern@amazon.com>
peternied · Mar 18, 2024 · b71ee75 · b71ee75
1 parent c40f46f
commit b71ee75
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/main/java/org/opensearch/security/dlic/rest/api/ConfigUpgradeApiAction.java b/src/main/java/org/opensearch/security/dlic/rest/api/ConfigUpgradeApiAction.java
@@ -365,6 +365,7 @@ public boolean hasChanges() {
             return !itemsGroupedByOperation.isEmpty();
         }
 
+        /** Adds the config item changes to the json node */
         public void addToNode(final ObjectNode node) {
             final var allOperations = JsonNodeFactory.instance.objectNode();
             itemsGroupedByOperation.forEach((operation, items) -> {
@@ -374,6 +375,10 @@ public void addToNode(final ObjectNode node) {
             node.set(config.toLCString(), allOperations);
         }
 
+        /**
+         * Classifies the changes to this config into groupings by the type of change, for
+         * multiple changes types on the same item they are groupped as 'modify'
+         */
         private static Map<String, List<String>> classifyChanges(final JsonNode differences) {
             final var items = new HashMap<String, String>();
             differences.forEach(node -> {