Add javadoc

Signed-off-by: Craig Perkins <[email protected]>
opensearch-project · Jul 3, 2024 · e2ef9c4 · e2ef9c4
1 parent 179e8d8
commit e2ef9c4
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/server/src/main/java/org/opensearch/indices/SystemIndexRegistry.java b/server/src/main/java/org/opensearch/indices/SystemIndexRegistry.java
@@ -28,6 +28,13 @@
 import static java.util.Collections.unmodifiableMap;
 import static org.opensearch.tasks.TaskResultsService.TASK_INDEX;
 
+/**
+ * This class holds the {@link SystemIndexDescriptor} objects that represent system indices the
+ * node knows about. This class also contains static methods that identify if index expressions match
+ * registered system index patterns
+ *
+ * @opensearch.api
+ */
 public class SystemIndexRegistry {
     private static final SystemIndexDescriptor TASK_INDEX_DESCRIPTOR = new SystemIndexDescriptor(TASK_INDEX + "*", "Task Result Index");
     private static final Map<String, Collection<SystemIndexDescriptor>> SERVER_SYSTEM_INDEX_DESCRIPTORS = singletonMap(