update comment for log entry for OpenSearch

Signed-off-by: Sean Kao <[email protected]>
opensearch-project · Jul 2, 2024 · d0e8f33 · d0e8f33
1 parent b1f67a2
commit d0e8f33
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/flint-core/src/main/scala/org/opensearch/flint/core/storage/FlintOpenSearchMetadataLog.java b/flint-core/src/main/scala/org/opensearch/flint/core/storage/FlintOpenSearchMetadataLog.java
@@ -36,6 +36,12 @@
 /**
  * Flint metadata log in OpenSearch store. For now use single doc instead of maintaining history
  * of metadata log.
+ * Expects the following fields from maps in FlintMetadataLogEntry:
+ * - entryVersion:
+ *   - seqNo: Long
+ *   - primaryTerm: Long
+ * - storageContext:
+ *   - dataSourceName: String
  */
 public class FlintOpenSearchMetadataLog implements FlintMetadataLog<FlintMetadataLogEntry> {