Add missed API visibility annotations for public APIs (#12920)

Signed-off-by: Ashish Singh <[email protected]>
opensearch-project · Mar 26, 2024 · f6d6fd3 · f6d6fd3
1 parent 3907ec9
commit f6d6fd3
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 2 deletions.
diff --git a/server/src/main/java/org/opensearch/common/blobstore/BlobPath.java b/server/src/main/java/org/opensearch/common/blobstore/BlobPath.java
@@ -33,6 +33,7 @@
 package org.opensearch.common.blobstore;
 
 import org.opensearch.common.Nullable;
+import org.opensearch.common.annotation.PublicApi;
 
 import java.util.ArrayList;
 import java.util.Collections;
@@ -42,8 +43,9 @@
 /**
  * The list of paths where a blob can reside.  The contents of the paths are dependent upon the implementation of {@link BlobContainer}.
  *
- * @opensearch.internal
+ * @opensearch.api
  */
+@PublicApi(since = "1.0.0")
 public class BlobPath implements Iterable<String> {
 
     private static final String SEPARATOR = "/";

diff --git a/server/src/main/java/org/opensearch/index/remote/RemoteStoreDataEnums.java b/server/src/main/java/org/opensearch/index/remote/RemoteStoreDataEnums.java
@@ -8,6 +8,8 @@
 
 package org.opensearch.index.remote;
 
+import org.opensearch.common.annotation.PublicApi;
+
 import java.util.Set;
 
 import static org.opensearch.index.remote.RemoteStoreDataEnums.DataType.DATA;
@@ -16,13 +18,14 @@
 /**
  * This class contains the different enums related to remote store data categories and types.
  *
- * @opensearch.internal
+ * @opensearch.api
  */
 public class RemoteStoreDataEnums {
 
     /**
      * Categories of the data in Remote store.
      */
+    @PublicApi(since = "2.14.0")
     public enum DataCategory {
         SEGMENTS("segments", Set.of(DataType.values())),
         TRANSLOG("translog", Set.of(DATA, METADATA));
@@ -47,6 +50,7 @@ public String getName() {
     /**
      * Types of data in remote store.
      */
+    @PublicApi(since = "2.14.0")
     public enum DataType {
         DATA("data"),
         METADATA("metadata"),

diff --git a/server/src/main/java/org/opensearch/index/remote/RemoteStorePathType.java b/server/src/main/java/org/opensearch/index/remote/RemoteStorePathType.java
@@ -8,6 +8,7 @@
 
 package org.opensearch.index.remote;
 
+import org.opensearch.common.annotation.PublicApi;
 import org.opensearch.common.blobstore.BlobPath;
 import org.opensearch.index.remote.RemoteStoreDataEnums.DataCategory;
 import org.opensearch.index.remote.RemoteStoreDataEnums.DataType;
@@ -20,6 +21,7 @@
  *
  * @opensearch.internal
  */
+@PublicApi(since = "2.14.0")
 public enum RemoteStorePathType {
 
     FIXED {