Skip to content

Commit ac0bb83

Browse files
authored
Added missed API visibility annotations for public / experimental APIs (opensearch-project#12864)
Signed-off-by: Andriy Redko <andriy.redko@aiven.io>
1 parent c04dad5 commit ac0bb83

33 files changed

+121
-29
lines changed

libs/core/src/main/java/org/opensearch/OpenSearchException.java

+3-1
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333

3434
import org.opensearch.common.CheckedFunction;
3535
import org.opensearch.common.Nullable;
36+
import org.opensearch.common.annotation.PublicApi;
3637
import org.opensearch.common.collect.Tuple;
3738
import org.opensearch.core.ParseField;
3839
import org.opensearch.core.common.Strings;
@@ -69,8 +70,9 @@
6970
/**
7071
* A core library base class for all opensearch exceptions.
7172
*
72-
* @opensearch.internal
73+
* @opensearch.api
7374
*/
75+
@PublicApi(since = "1.0.0")
7476
public class OpenSearchException extends RuntimeException implements Writeable, ToXContentFragment {
7577

7678
protected static final Version UNKNOWN_VERSION_ADDED = Version.fromId(0);

libs/core/src/main/java/org/opensearch/core/common/breaker/CircuitBreaker.java

+7-2
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,17 @@
3232

3333
package org.opensearch.core.common.breaker;
3434

35+
import org.opensearch.common.annotation.PublicApi;
36+
3537
import java.util.Locale;
3638

3739
/**
3840
* Interface for an object that can be incremented, breaking after some
3941
* configured limit has been reached.
4042
*
41-
* @opensearch.internal
43+
* @opensearch.api
4244
*/
45+
@PublicApi(since = "1.0.0")
4346
public interface CircuitBreaker {
4447

4548
/**
@@ -72,8 +75,10 @@ public interface CircuitBreaker {
7275
/**
7376
* The type of breaker
7477
* can be {@link #MEMORY}, {@link #PARENT}, or {@link #NOOP}
75-
* @opensearch.internal
78+
*
79+
* @opensearch.api
7680
*/
81+
@PublicApi(since = "1.0.0")
7782
enum Type {
7883
/** A regular or ChildMemoryCircuitBreaker */
7984
MEMORY,

libs/core/src/main/java/org/opensearch/core/common/transport/BoundTransportAddress.java

+3-1
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232

3333
package org.opensearch.core.common.transport;
3434

35+
import org.opensearch.common.annotation.PublicApi;
3536
import org.opensearch.common.network.InetAddresses;
3637
import org.opensearch.core.common.io.stream.StreamInput;
3738
import org.opensearch.core.common.io.stream.StreamOutput;
@@ -44,8 +45,9 @@
4445
* the addresses the transport is bound to, and the other is the published one that represents the address clients
4546
* should communicate on.
4647
*
47-
* @opensearch.internal
48+
* @opensearch.api
4849
*/
50+
@PublicApi(since = "1.0.0")
4951
public class BoundTransportAddress implements Writeable {
5052

5153
private TransportAddress[] boundAddresses;

libs/core/src/main/java/org/opensearch/core/transport/TransportResponse.java

+3-1
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232

3333
package org.opensearch.core.transport;
3434

35+
import org.opensearch.common.annotation.PublicApi;
3536
import org.opensearch.core.common.io.stream.StreamInput;
3637
import org.opensearch.core.common.io.stream.StreamOutput;
3738

@@ -40,8 +41,9 @@
4041
/**
4142
* Response over the transport interface
4243
*
43-
* @opensearch.internal
44+
* @opensearch.api
4445
*/
46+
@PublicApi(since = "1.0.0")
4547
public abstract class TransportResponse extends TransportMessage {
4648

4749
/**

libs/core/src/main/java/org/opensearch/semver/SemverRange.java

+4
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010

1111
import org.opensearch.Version;
1212
import org.opensearch.common.Nullable;
13+
import org.opensearch.common.annotation.PublicApi;
1314
import org.opensearch.core.xcontent.ToXContentFragment;
1415
import org.opensearch.core.xcontent.XContentBuilder;
1516
import org.opensearch.semver.expr.Caret;
@@ -31,7 +32,10 @@
3132
* <li>'~' Allows for patch version variability starting from the range version. For example, ~1.2.3 range would match versions greater than or equal to 1.2.3 but less than 1.3.0</li>
3233
* <li>'^' Allows for patch and minor version variability starting from the range version. For example, ^1.2.3 range would match versions greater than or equal to 1.2.3 but less than 2.0.0</li>
3334
* </ul>
35+
*
36+
* @opensearch.api
3437
*/
38+
@PublicApi(since = "2.13.0")
3539
public class SemverRange implements ToXContentFragment {
3640

3741
private final Version rangeVersion;

server/src/main/java/org/opensearch/action/support/clustermanager/ClusterManagerNodeRequest.java

+3-1
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
package org.opensearch.action.support.clustermanager;
3434

3535
import org.opensearch.action.ActionRequest;
36+
import org.opensearch.common.annotation.PublicApi;
3637
import org.opensearch.common.unit.TimeValue;
3738
import org.opensearch.core.common.io.stream.StreamInput;
3839
import org.opensearch.core.common.io.stream.StreamOutput;
@@ -42,8 +43,9 @@
4243
/**
4344
* A based request for cluster-manager based operation.
4445
*
45-
* @opensearch.internal
46+
* @opensearch.api
4647
*/
48+
@PublicApi(since = "1.0.0")
4749
public abstract class ClusterManagerNodeRequest<Request extends ClusterManagerNodeRequest<Request>> extends ActionRequest {
4850

4951
public static final TimeValue DEFAULT_CLUSTER_MANAGER_NODE_TIMEOUT = TimeValue.timeValueSeconds(30);

server/src/main/java/org/opensearch/common/cache/RemovalListener.java

+4-1
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,14 @@
3232

3333
package org.opensearch.common.cache;
3434

35+
import org.opensearch.common.annotation.ExperimentalApi;
36+
3537
/**
3638
* Listener for removing an element from the cache
3739
*
38-
* @opensearch.internal
40+
* @opensearch.experimental
3941
*/
42+
@ExperimentalApi
4043
@FunctionalInterface
4144
public interface RemovalListener<K, V> {
4245
void onRemoval(RemovalNotification<K, V> notification);

server/src/main/java/org/opensearch/common/cache/policy/CachedQueryResult.java

+4
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88

99
package org.opensearch.common.cache.policy;
1010

11+
import org.opensearch.common.annotation.ExperimentalApi;
1112
import org.opensearch.core.common.bytes.BytesReference;
1213
import org.opensearch.core.common.io.stream.NamedWriteableAwareStreamInput;
1314
import org.opensearch.core.common.io.stream.NamedWriteableRegistry;
@@ -62,7 +63,10 @@ public void writeToNoId(StreamOutput out) throws IOException {
6263
/**
6364
* A class containing information needed for all cache policies
6465
* to decide whether to admit a given value.
66+
*
67+
* @opensearch.experimental
6568
*/
69+
@ExperimentalApi
6670
public static class PolicyValues implements Writeable {
6771
final long tookTimeNanos;
6872
// More values can be added here as they're needed for future policies

server/src/main/java/org/opensearch/common/cache/serializer/Serializer.java

+5
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,15 @@
88

99
package org.opensearch.common.cache.serializer;
1010

11+
import org.opensearch.common.annotation.ExperimentalApi;
12+
1113
/**
1214
* Defines an interface for serializers, to be used by pluggable caches.
1315
* T is the class of the original object, and U is the serialized class.
16+
*
17+
* @opensearch.experimental
1418
*/
19+
@ExperimentalApi
1520
public interface Serializer<T, U> {
1621
/**
1722
* Serializes an object.

server/src/main/java/org/opensearch/common/lucene/index/OpenSearchDirectoryReader.java

+6-1
Original file line numberDiff line numberDiff line change
@@ -84,8 +84,10 @@ public DelegatingCacheHelper getDelegatingCacheHelper() {
8484

8585
/**
8686
* Wraps existing IndexReader cache helper which internally provides a way to wrap CacheKey.
87-
* @opensearch.internal
87+
*
88+
* @opensearch.api
8889
*/
90+
@PublicApi(since = "2.13.0")
8991
public class DelegatingCacheHelper implements CacheHelper {
9092
private final CacheHelper cacheHelper;
9193
private final DelegatingCacheKey serializableCacheKey;
@@ -113,7 +115,10 @@ public void addClosedListener(ClosedListener listener) {
113115
/**
114116
* Wraps internal IndexReader.CacheKey and attaches a uniqueId to it which can be eventually be used instead of
115117
* object itself for serialization purposes.
118+
*
119+
* @opensearch.api
116120
*/
121+
@PublicApi(since = "2.13.0")
117122
public class DelegatingCacheKey {
118123
private final CacheKey cacheKey;
119124
private final String uniqueId;

server/src/main/java/org/opensearch/common/metrics/MeanMetric.java

+4-1
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,16 @@
3232

3333
package org.opensearch.common.metrics;
3434

35+
import org.opensearch.common.annotation.PublicApi;
36+
3537
import java.util.concurrent.atomic.LongAdder;
3638

3739
/**
3840
* An average metric for tracking.
3941
*
40-
* @opensearch.internal
42+
* @opensearch.api
4143
*/
44+
@PublicApi(since = "1.0.0")
4245
public class MeanMetric implements Metric {
4346

4447
private final LongAdder counter = new LongAdder();

server/src/main/java/org/opensearch/http/HttpInfo.java

+3-1
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232

3333
package org.opensearch.http;
3434

35+
import org.opensearch.common.annotation.PublicApi;
3536
import org.opensearch.common.logging.DeprecationLogger;
3637
import org.opensearch.common.network.InetAddresses;
3738
import org.opensearch.core.common.io.stream.StreamInput;
@@ -47,8 +48,9 @@
4748
/**
4849
* Information about an http connection
4950
*
50-
* @opensearch.internal
51+
* @opensearch.api
5152
*/
53+
@PublicApi(since = "1.0.0")
5254
public class HttpInfo implements ReportingService.Info {
5355

5456
private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(HttpInfo.class);

server/src/main/java/org/opensearch/http/HttpServerTransport.java

+3-1
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232

3333
package org.opensearch.http;
3434

35+
import org.opensearch.common.annotation.PublicApi;
3536
import org.opensearch.common.lifecycle.LifecycleComponent;
3637
import org.opensearch.common.util.concurrent.ThreadContext;
3738
import org.opensearch.core.common.transport.BoundTransportAddress;
@@ -42,8 +43,9 @@
4243
/**
4344
* HTTP Transport server
4445
*
45-
* @opensearch.internal
46+
* @opensearch.api
4647
*/
48+
@PublicApi(since = "1.0.0")
4749
public interface HttpServerTransport extends LifecycleComponent, ReportingService<HttpInfo> {
4850

4951
String HTTP_SERVER_WORKER_THREAD_NAME_PREFIX = "http_server_worker";

server/src/main/java/org/opensearch/http/HttpStats.java

+3-1
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232

3333
package org.opensearch.http;
3434

35+
import org.opensearch.common.annotation.PublicApi;
3536
import org.opensearch.core.common.io.stream.StreamInput;
3637
import org.opensearch.core.common.io.stream.StreamOutput;
3738
import org.opensearch.core.common.io.stream.Writeable;
@@ -43,8 +44,9 @@
4344
/**
4445
* Stats for HTTP connections
4546
*
46-
* @opensearch.internal
47+
* @opensearch.api
4748
*/
49+
@PublicApi(since = "1.0.0")
4850
public class HttpStats implements Writeable, ToXContentFragment {
4951

5052
private final long serverOpen;

server/src/main/java/org/opensearch/index/codec/fuzzy/LongArrayBackedBitSet.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ class LongArrayBackedBitSet implements Accountable, Closeable {
3939
/**
4040
* Constructor which uses Lucene's IndexInput to read the bitset into a read-only buffer.
4141
* @param in IndexInput containing the serialized bitset.
42-
* @throws IOException
42+
* @throws IOException I/O exception
4343
*/
4444
LongArrayBackedBitSet(IndexInput in) throws IOException {
4545
underlyingArrayLength = in.readLong();

server/src/main/java/org/opensearch/index/store/RemoteSegmentStoreDirectoryFactory.java

+3-1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
package org.opensearch.index.store;
1010

1111
import org.apache.lucene.store.Directory;
12+
import org.opensearch.common.annotation.PublicApi;
1213
import org.opensearch.common.blobstore.BlobPath;
1314
import org.opensearch.core.index.shard.ShardId;
1415
import org.opensearch.index.IndexSettings;
@@ -28,8 +29,9 @@
2829
/**
2930
* Factory for a remote store directory
3031
*
31-
* @opensearch.internal
32+
* @opensearch.api
3233
*/
34+
@PublicApi(since = "2.3.0")
3335
public class RemoteSegmentStoreDirectoryFactory implements IndexStorePlugin.DirectoryFactory {
3436
private static final String SEGMENTS = "segments";
3537

server/src/main/java/org/opensearch/rest/BaseRestHandler.java

+5
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@
4040
import org.opensearch.action.support.clustermanager.ClusterManagerNodeRequest;
4141
import org.opensearch.client.node.NodeClient;
4242
import org.opensearch.common.CheckedConsumer;
43+
import org.opensearch.common.annotation.PublicApi;
4344
import org.opensearch.common.collect.Tuple;
4445
import org.opensearch.common.logging.DeprecationLogger;
4546
import org.opensearch.common.settings.Setting;
@@ -73,6 +74,7 @@
7374
*
7475
* @opensearch.api
7576
*/
77+
@PublicApi(since = "1.0.0")
7678
public abstract class BaseRestHandler implements RestHandler {
7779

7880
public static final Setting<Boolean> MULTI_ALLOW_EXPLICIT_INDEX = Setting.boolSetting(
@@ -195,8 +197,11 @@ protected final String unrecognized(
195197
/**
196198
* REST requests are handled by preparing a channel consumer that represents the execution of
197199
* the request against a channel.
200+
*
201+
* @opensearch.api
198202
*/
199203
@FunctionalInterface
204+
@PublicApi(since = "1.0.0")
200205
protected interface RestChannelConsumer extends CheckedConsumer<RestChannel, Exception> {}
201206

202207
/**

server/src/main/java/org/opensearch/rest/RestChannel.java

+2
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
package org.opensearch.rest;
3434

3535
import org.opensearch.common.Nullable;
36+
import org.opensearch.common.annotation.PublicApi;
3637
import org.opensearch.common.io.stream.BytesStreamOutput;
3738
import org.opensearch.core.xcontent.MediaType;
3839
import org.opensearch.core.xcontent.XContentBuilder;
@@ -44,6 +45,7 @@
4445
*
4546
* @opensearch.api
4647
*/
48+
@PublicApi(since = "1.0.0")
4749
public interface RestChannel {
4850

4951
XContentBuilder newBuilder() throws IOException;

server/src/main/java/org/opensearch/rest/RestHandler.java

+3-1
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
package org.opensearch.rest;
3434

3535
import org.opensearch.client.node.NodeClient;
36+
import org.opensearch.common.annotation.PublicApi;
3637
import org.opensearch.core.xcontent.XContent;
3738
import org.opensearch.rest.RestRequest.Method;
3839

@@ -180,8 +181,9 @@ public boolean allowSystemIndexAccessByDefault() {
180181
/**
181182
* Route for the request.
182183
*
183-
* @opensearch.internal
184+
* @opensearch.api
184185
*/
186+
@PublicApi(since = "1.0.0")
185187
class Route {
186188

187189
protected final String path;

server/src/main/java/org/opensearch/rest/RestResponse.java

+2
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
package org.opensearch.rest;
3434

3535
import org.opensearch.OpenSearchException;
36+
import org.opensearch.common.annotation.PublicApi;
3637
import org.opensearch.common.lease.Releasable;
3738
import org.opensearch.core.common.bytes.BytesReference;
3839
import org.opensearch.core.rest.RestStatus;
@@ -49,6 +50,7 @@
4950
*
5051
* @opensearch.api
5152
*/
53+
@PublicApi(since = "1.0.0")
5254
public abstract class RestResponse {
5355

5456
private Map<String, List<String>> customHeaders;

0 commit comments

Comments
 (0)