diff --git a/server/src/main/java/org/opensearch/rest/AbstractRestChannel.java b/server/src/main/java/org/opensearch/rest/AbstractRestChannel.java index eb5fcccee38..389841100af 100644 --- a/server/src/main/java/org/opensearch/rest/AbstractRestChannel.java +++ b/server/src/main/java/org/opensearch/rest/AbstractRestChannel.java @@ -47,6 +47,11 @@ import java.util.function.Predicate; import static java.util.stream.Collectors.toSet; +/** + * Base REST channel + * + * @opensearch.api + */ public abstract class AbstractRestChannel implements RestChannel { private static final Predicate INCLUDE_FILTER = f -> f.charAt(0) != '-'; diff --git a/server/src/main/java/org/opensearch/rest/BaseRestHandler.java b/server/src/main/java/org/opensearch/rest/BaseRestHandler.java index e16e385910d..4519f2a3622 100644 --- a/server/src/main/java/org/opensearch/rest/BaseRestHandler.java +++ b/server/src/main/java/org/opensearch/rest/BaseRestHandler.java @@ -67,6 +67,8 @@ import java.util.stream.Collectors; * the transport requests executed by the associated client. While the context is fully copied over, not all the headers * are copied, but a selected few. It is possible to control what headers are copied over by returning them in * {@link ActionPlugin#getRestHeaders()}. + * + * @opensearch.api */ public abstract class BaseRestHandler implements RestHandler { diff --git a/server/src/main/java/org/opensearch/rest/BytesRestResponse.java b/server/src/main/java/org/opensearch/rest/BytesRestResponse.java index 7d2b49f3f01..68b3cc664fc 100644 --- a/server/src/main/java/org/opensearch/rest/BytesRestResponse.java +++ b/server/src/main/java/org/opensearch/rest/BytesRestResponse.java @@ -52,6 +52,11 @@ import static org.opensearch.OpenSearchException.REST_EXCEPTION_SKIP_STACK_TRACE import static org.opensearch.OpenSearchException.REST_EXCEPTION_SKIP_STACK_TRACE_DEFAULT; import static org.opensearch.common.xcontent.XContentParserUtils.ensureExpectedToken; +/** + * REST response in bytes + * + * @opensearch.api + */ public class BytesRestResponse extends RestResponse { public static final String TEXT_CONTENT_TYPE = "text/plain; charset=UTF-8"; diff --git a/server/src/main/java/org/opensearch/rest/DeprecationRestHandler.java b/server/src/main/java/org/opensearch/rest/DeprecationRestHandler.java index 85a7f0f0281..e4e0acb2123 100644 --- a/server/src/main/java/org/opensearch/rest/DeprecationRestHandler.java +++ b/server/src/main/java/org/opensearch/rest/DeprecationRestHandler.java @@ -40,6 +40,8 @@ import java.util.Objects; /** * {@code DeprecationRestHandler} provides a proxy for any existing {@link RestHandler} so that usage of the handler can be * logged using the {@link DeprecationLogger}. + * + * @opensearch.api */ public class DeprecationRestHandler implements RestHandler { diff --git a/server/src/main/java/org/opensearch/rest/MethodHandlers.java b/server/src/main/java/org/opensearch/rest/MethodHandlers.java index d8f5488dc2e..8c29bf2e660 100644 --- a/server/src/main/java/org/opensearch/rest/MethodHandlers.java +++ b/server/src/main/java/org/opensearch/rest/MethodHandlers.java @@ -40,6 +40,8 @@ import java.util.Set; /** * Encapsulate multiple handlers for the same path, allowing different handlers for different HTTP verbs. + * + * @opensearch.api */ final class MethodHandlers { diff --git a/server/src/main/java/org/opensearch/rest/RestChannel.java b/server/src/main/java/org/opensearch/rest/RestChannel.java index e3108b6ca4b..6d136a6cb6a 100644 --- a/server/src/main/java/org/opensearch/rest/RestChannel.java +++ b/server/src/main/java/org/opensearch/rest/RestChannel.java @@ -41,6 +41,8 @@ import java.io.IOException; /** * A channel used to construct bytes / builder based outputs, and send responses. + * + * @opensearch.api */ public interface RestChannel { diff --git a/server/src/main/java/org/opensearch/rest/RestController.java b/server/src/main/java/org/opensearch/rest/RestController.java index f2030eb83a5..b576f8b83e5 100644 --- a/server/src/main/java/org/opensearch/rest/RestController.java +++ b/server/src/main/java/org/opensearch/rest/RestController.java @@ -75,6 +75,11 @@ import static org.opensearch.rest.RestStatus.METHOD_NOT_ALLOWED; import static org.opensearch.rest.RestStatus.NOT_ACCEPTABLE; import static org.opensearch.rest.RestStatus.OK; +/** + * OpenSearch REST controller + * + * @opensearch.api + */ public class RestController implements HttpServerTransport.Dispatcher { private static final Logger logger = LogManager.getLogger(RestController.class); diff --git a/server/src/main/java/org/opensearch/rest/RestHandler.java b/server/src/main/java/org/opensearch/rest/RestHandler.java index 9afa2d94b20..14f54d37163 100644 --- a/server/src/main/java/org/opensearch/rest/RestHandler.java +++ b/server/src/main/java/org/opensearch/rest/RestHandler.java @@ -43,6 +43,8 @@ import java.util.stream.Collectors; /** * Handler for REST requests + * + * @opensearch.api */ @FunctionalInterface public interface RestHandler { diff --git a/server/src/main/java/org/opensearch/rest/RestHeaderDefinition.java b/server/src/main/java/org/opensearch/rest/RestHeaderDefinition.java index 7e7b851a42d..9bea8055077 100644 --- a/server/src/main/java/org/opensearch/rest/RestHeaderDefinition.java +++ b/server/src/main/java/org/opensearch/rest/RestHeaderDefinition.java @@ -35,6 +35,8 @@ package org.opensearch.rest; /** * A definition for an http header that should be copied to the {@link org.opensearch.common.util.concurrent.ThreadContext} when * reading the request on the rest layer. + * + * @opensearch.api */ public final class RestHeaderDefinition { private final String name; diff --git a/server/src/main/java/org/opensearch/rest/RestRequest.java b/server/src/main/java/org/opensearch/rest/RestRequest.java index 7d11da7e122..65ba5b61eed 100644 --- a/server/src/main/java/org/opensearch/rest/RestRequest.java +++ b/server/src/main/java/org/opensearch/rest/RestRequest.java @@ -67,6 +67,11 @@ import java.util.stream.Collectors; import static org.opensearch.common.unit.ByteSizeValue.parseBytesSizeValue; import static org.opensearch.common.unit.TimeValue.parseTimeValue; +/** + * REST Request + * + * @opensearch.api + */ public class RestRequest implements ToXContent.Params { // tchar pattern as defined by RFC7230 section 3.2.6 diff --git a/server/src/main/java/org/opensearch/rest/RestRequestFilter.java b/server/src/main/java/org/opensearch/rest/RestRequestFilter.java index 9b17dd44325..e457ace80c8 100644 --- a/server/src/main/java/org/opensearch/rest/RestRequestFilter.java +++ b/server/src/main/java/org/opensearch/rest/RestRequestFilter.java @@ -48,6 +48,8 @@ import java.util.Set; /** * Identifies an object that supplies a filter for the content of a {@link RestRequest}. This interface should be implemented by a * {@link org.opensearch.rest.RestHandler} that expects there will be sensitive content in the body of the request such as a password + * + * @opensearch.api */ public interface RestRequestFilter { diff --git a/server/src/main/java/org/opensearch/rest/RestResponse.java b/server/src/main/java/org/opensearch/rest/RestResponse.java index 80d80cec3b3..bbf6e5d34bd 100644 --- a/server/src/main/java/org/opensearch/rest/RestResponse.java +++ b/server/src/main/java/org/opensearch/rest/RestResponse.java @@ -42,6 +42,11 @@ import java.util.List; import java.util.Map; import java.util.Set; +/** + * OpenSearch REST response + * + * @opensearch.api + */ public abstract class RestResponse { private Map> customHeaders; diff --git a/server/src/main/java/org/opensearch/rest/RestStatus.java b/server/src/main/java/org/opensearch/rest/RestStatus.java index 5f50559ef0f..0b0fdeb22fa 100644 --- a/server/src/main/java/org/opensearch/rest/RestStatus.java +++ b/server/src/main/java/org/opensearch/rest/RestStatus.java @@ -42,6 +42,11 @@ import java.util.Map; import static java.util.Collections.unmodifiableMap; +/** + * OpenSearch REST status + * + * @opensearch.api + */ public enum RestStatus { /** * The client SHOULD continue with its request. This interim response is used to inform the client that the diff --git a/server/src/main/java/org/opensearch/rest/RestUtils.java b/server/src/main/java/org/opensearch/rest/RestUtils.java index 913910cead2..da2a14126d5 100644 --- a/server/src/main/java/org/opensearch/rest/RestUtils.java +++ b/server/src/main/java/org/opensearch/rest/RestUtils.java @@ -42,6 +42,11 @@ import java.util.Arrays; import java.util.Map; import java.util.regex.Pattern; +/** + * REST utility class + * + * @opensearch.api + */ public class RestUtils { /** diff --git a/server/src/main/java/org/opensearch/rest/action/RestActionListener.java b/server/src/main/java/org/opensearch/rest/action/RestActionListener.java index d0e897ea811..d1c1c98b1b8 100644 --- a/server/src/main/java/org/opensearch/rest/action/RestActionListener.java +++ b/server/src/main/java/org/opensearch/rest/action/RestActionListener.java @@ -43,6 +43,8 @@ import java.io.IOException; /** * An action listener that requires {@link #processResponse(Object)} to be implemented * and will automatically handle failures. + * + * @opensearch.api */ public abstract class RestActionListener implements ActionListener { diff --git a/server/src/main/java/org/opensearch/rest/action/RestActions.java b/server/src/main/java/org/opensearch/rest/action/RestActions.java index 7c5aaf4e763..59446eca339 100644 --- a/server/src/main/java/org/opensearch/rest/action/RestActions.java +++ b/server/src/main/java/org/opensearch/rest/action/RestActions.java @@ -61,6 +61,11 @@ import java.util.List; import static org.opensearch.index.query.AbstractQueryBuilder.parseInnerQueryBuilder; +/** + * REST actions + * + * @opensearch.api + */ public class RestActions { public static final ParseField _SHARDS_FIELD = new ParseField("_shards"); diff --git a/server/src/main/java/org/opensearch/rest/action/RestBuilderListener.java b/server/src/main/java/org/opensearch/rest/action/RestBuilderListener.java index 03e70388660..07d1dcf180f 100644 --- a/server/src/main/java/org/opensearch/rest/action/RestBuilderListener.java +++ b/server/src/main/java/org/opensearch/rest/action/RestBuilderListener.java @@ -38,6 +38,8 @@ import org.opensearch.rest.RestResponse; /** * A REST action listener that builds an {@link XContentBuilder} based response. + * + * @opensearch.api */ public abstract class RestBuilderListener extends RestResponseListener { diff --git a/server/src/main/java/org/opensearch/rest/action/RestCancellableNodeClient.java b/server/src/main/java/org/opensearch/rest/action/RestCancellableNodeClient.java index 046fb060733..ad84b6db0ed 100644 --- a/server/src/main/java/org/opensearch/rest/action/RestCancellableNodeClient.java +++ b/server/src/main/java/org/opensearch/rest/action/RestCancellableNodeClient.java @@ -58,6 +58,8 @@ import static org.opensearch.action.admin.cluster.node.tasks.get.GetTaskAction.T /** * A {@linkplain Client} that cancels tasks executed locally when the provided {@link HttpChannel} * is closed before completion. + * + * @opensearch.api */ public class RestCancellableNodeClient extends FilterClient { private static final Map httpChannels = new ConcurrentHashMap<>(); diff --git a/server/src/main/java/org/opensearch/rest/action/RestFieldCapabilitiesAction.java b/server/src/main/java/org/opensearch/rest/action/RestFieldCapabilitiesAction.java index dea8e80687e..2c108732777 100644 --- a/server/src/main/java/org/opensearch/rest/action/RestFieldCapabilitiesAction.java +++ b/server/src/main/java/org/opensearch/rest/action/RestFieldCapabilitiesAction.java @@ -47,6 +47,11 @@ import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.GET; import static org.opensearch.rest.RestRequest.Method.POST; +/** + * Transport action to get field capabilities + * + * @opensearch.api + */ public class RestFieldCapabilitiesAction extends BaseRestHandler { @Override diff --git a/server/src/main/java/org/opensearch/rest/action/RestMainAction.java b/server/src/main/java/org/opensearch/rest/action/RestMainAction.java index a3a37ba7699..7c4ca1aabbc 100644 --- a/server/src/main/java/org/opensearch/rest/action/RestMainAction.java +++ b/server/src/main/java/org/opensearch/rest/action/RestMainAction.java @@ -51,6 +51,11 @@ import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.GET; import static org.opensearch.rest.RestRequest.Method.HEAD; +/** + * Main OpenSearch Transport action + * + * @opensearch.api + */ public class RestMainAction extends BaseRestHandler { @Override diff --git a/server/src/main/java/org/opensearch/rest/action/RestResponseListener.java b/server/src/main/java/org/opensearch/rest/action/RestResponseListener.java index 63d54000412..4dd1aa912dd 100644 --- a/server/src/main/java/org/opensearch/rest/action/RestResponseListener.java +++ b/server/src/main/java/org/opensearch/rest/action/RestResponseListener.java @@ -38,6 +38,8 @@ import org.opensearch.rest.RestResponse; /** * A REST enabled action listener that has a basic onFailure implementation, and requires * sub classes to only implement {@link #buildResponse(Object)}. + * + * @opensearch.api */ public abstract class RestResponseListener extends RestActionListener { diff --git a/server/src/main/java/org/opensearch/rest/action/RestStatusToXContentListener.java b/server/src/main/java/org/opensearch/rest/action/RestStatusToXContentListener.java index ade2ed6c3bd..6416c61140c 100644 --- a/server/src/main/java/org/opensearch/rest/action/RestStatusToXContentListener.java +++ b/server/src/main/java/org/opensearch/rest/action/RestStatusToXContentListener.java @@ -42,6 +42,8 @@ import java.util.function.Function; /** * Content listener that extracts that {@link RestStatus} from the response. + * + * @opensearch.api */ public class RestStatusToXContentListener extends RestToXContentListener { private final Function extractLocation; diff --git a/server/src/main/java/org/opensearch/rest/action/RestToXContentListener.java b/server/src/main/java/org/opensearch/rest/action/RestToXContentListener.java index 8ea55a4ccf4..cba79b0bc99 100644 --- a/server/src/main/java/org/opensearch/rest/action/RestToXContentListener.java +++ b/server/src/main/java/org/opensearch/rest/action/RestToXContentListener.java @@ -43,6 +43,8 @@ import org.opensearch.rest.RestStatus; /** * A REST based action listener that assumes the response is of type {@link ToXContent} and automatically * builds an XContent based response (wrapping the toXContent in startObject/endObject). + * + * @opensearch.api */ public class RestToXContentListener extends RestResponseListener { diff --git a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestAddVotingConfigExclusionAction.java b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestAddVotingConfigExclusionAction.java index c5f9d168a72..f0498588608 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestAddVotingConfigExclusionAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestAddVotingConfigExclusionAction.java @@ -49,6 +49,11 @@ import java.util.List; import static org.opensearch.rest.RestRequest.Method.POST; +/** + * Transport action to add voting config exclusions + * + * @opensearch.api + */ public class RestAddVotingConfigExclusionAction extends BaseRestHandler { private static final TimeValue DEFAULT_TIMEOUT = TimeValue.timeValueSeconds(30L); private static final Logger logger = LogManager.getLogger(RestAddVotingConfigExclusionAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestCancelTasksAction.java b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestCancelTasksAction.java index 5415ad260b9..779d172b5d7 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestCancelTasksAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestCancelTasksAction.java @@ -49,6 +49,11 @@ import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.POST; import static org.opensearch.rest.action.admin.cluster.RestListTasksAction.listTasksResponseListener; +/** + * Transport action to cancel tasks + * + * @opensearch.api + */ public class RestCancelTasksAction extends BaseRestHandler { private final Supplier nodesInCluster; diff --git a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestCleanupRepositoryAction.java b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestCleanupRepositoryAction.java index c568eae91a5..a5be2fcf0f2 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestCleanupRepositoryAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestCleanupRepositoryAction.java @@ -48,6 +48,8 @@ import static org.opensearch.rest.RestRequest.Method.POST; /** * Cleans up a repository + * + * @opensearch.api */ public class RestCleanupRepositoryAction extends BaseRestHandler { diff --git a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClearVotingConfigExclusionsAction.java b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClearVotingConfigExclusionsAction.java index 73a5a0c321b..aa8a4879da5 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClearVotingConfigExclusionsAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClearVotingConfigExclusionsAction.java @@ -45,6 +45,11 @@ import java.util.List; import static java.util.Collections.singletonList; import static org.opensearch.rest.RestRequest.Method.DELETE; +/** + * Transport action to clear voting config exclusions + * + * @opensearch.api + */ public class RestClearVotingConfigExclusionsAction extends BaseRestHandler { @Override diff --git a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestCloneSnapshotAction.java b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestCloneSnapshotAction.java index abf1efa19f7..905b8bf7805 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestCloneSnapshotAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestCloneSnapshotAction.java @@ -50,6 +50,8 @@ import static org.opensearch.rest.RestRequest.Method.PUT; /** * Clones indices from one snapshot into another snapshot in the same repository + * + * @opensearch.api */ public class RestCloneSnapshotAction extends BaseRestHandler { diff --git a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClusterAllocationExplainAction.java b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClusterAllocationExplainAction.java index b059e75870e..a592b45eba8 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClusterAllocationExplainAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClusterAllocationExplainAction.java @@ -55,6 +55,8 @@ import static org.opensearch.rest.RestRequest.Method.POST; /** * Class handling cluster allocation explanation at the REST level + * + * @opensearch.api */ public class RestClusterAllocationExplainAction extends BaseRestHandler { diff --git a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClusterGetSettingsAction.java b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClusterGetSettingsAction.java index 1238cd2a818..9abb3cd42ce 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClusterGetSettingsAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClusterGetSettingsAction.java @@ -58,6 +58,11 @@ import java.util.Set; import static java.util.Collections.singletonList; import static org.opensearch.rest.RestRequest.Method.GET; +/** + * Transport action to get settings + * + * @opensearch.api + */ public class RestClusterGetSettingsAction extends BaseRestHandler { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestClusterGetSettingsAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClusterHealthAction.java b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClusterHealthAction.java index 877e387a15e..efaad5a10e3 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClusterHealthAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClusterHealthAction.java @@ -55,6 +55,11 @@ import static java.util.Collections.unmodifiableList; import static org.opensearch.client.Requests.clusterHealthRequest; import static org.opensearch.rest.RestRequest.Method.GET; +/** + * Transport action to get cluster health + * + * @opensearch.api + */ public class RestClusterHealthAction extends BaseRestHandler { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestClusterHealthAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClusterRerouteAction.java b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClusterRerouteAction.java index dc5e0ba57e4..6a773101986 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClusterRerouteAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClusterRerouteAction.java @@ -58,6 +58,11 @@ import java.util.Set; import static java.util.Collections.singletonList; import static org.opensearch.rest.RestRequest.Method.POST; +/** + * Transport action to reroute documents + * + * @opensearch.api + */ public class RestClusterRerouteAction extends BaseRestHandler { private static final ObjectParser PARSER = new ObjectParser<>("cluster_reroute"); static { diff --git a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClusterSearchShardsAction.java b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClusterSearchShardsAction.java index 20cd11e0308..e1b1389c478 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClusterSearchShardsAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClusterSearchShardsAction.java @@ -49,6 +49,11 @@ import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.GET; import static org.opensearch.rest.RestRequest.Method.POST; +/** + * Transport action to search shards + * + * @opensearch.api + */ public class RestClusterSearchShardsAction extends BaseRestHandler { @Override diff --git a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClusterStateAction.java b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClusterStateAction.java index 02b1eaa741c..57208d2d048 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClusterStateAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClusterStateAction.java @@ -64,6 +64,11 @@ import static java.util.Collections.singletonMap; import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.GET; +/** + * Transport action to get cluster state + * + * @opensearch.api + */ public class RestClusterStateAction extends BaseRestHandler { private final SettingsFilter settingsFilter; diff --git a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClusterStatsAction.java b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClusterStatsAction.java index 9bbabcdba14..0766e838210 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClusterStatsAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClusterStatsAction.java @@ -45,6 +45,11 @@ import static java.util.Arrays.asList; import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.GET; +/** + * Transport action to get cluster stats + * + * @opensearch.api + */ public class RestClusterStatsAction extends BaseRestHandler { @Override diff --git a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClusterUpdateSettingsAction.java b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClusterUpdateSettingsAction.java index c05cdc752b5..2918238a196 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClusterUpdateSettingsAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClusterUpdateSettingsAction.java @@ -50,6 +50,11 @@ import java.util.Set; import static java.util.Collections.singletonList; import static org.opensearch.rest.RestRequest.Method.PUT; +/** + * Transport action to update cluster settings + * + * @opensearch.api + */ public class RestClusterUpdateSettingsAction extends BaseRestHandler { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestClusterUpdateSettingsAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestCreateSnapshotAction.java b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestCreateSnapshotAction.java index b3503f0dfbb..11147f219f3 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestCreateSnapshotAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestCreateSnapshotAction.java @@ -50,6 +50,8 @@ import static org.opensearch.rest.RestRequest.Method.PUT; /** * Creates a new snapshot + * + * @opensearch.api */ public class RestCreateSnapshotAction extends BaseRestHandler { diff --git a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestDeleteRepositoryAction.java b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestDeleteRepositoryAction.java index 5e53595e3a4..7e04a5e62d7 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestDeleteRepositoryAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestDeleteRepositoryAction.java @@ -48,6 +48,8 @@ import static org.opensearch.rest.RestRequest.Method.DELETE; /** * Unregisters a repository + * + * @opensearch.api */ public class RestDeleteRepositoryAction extends BaseRestHandler { diff --git a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestDeleteSnapshotAction.java b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestDeleteSnapshotAction.java index 891b84f8d08..03aa9cf0d49 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestDeleteSnapshotAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestDeleteSnapshotAction.java @@ -49,6 +49,8 @@ import static org.opensearch.rest.RestRequest.Method.DELETE; /** * Deletes a snapshot + * + * @opensearch.api */ public class RestDeleteSnapshotAction extends BaseRestHandler { diff --git a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestDeleteStoredScriptAction.java b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestDeleteStoredScriptAction.java index b303f769d21..03fae6d3b55 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestDeleteStoredScriptAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestDeleteStoredScriptAction.java @@ -44,6 +44,11 @@ import java.util.List; import static java.util.Collections.singletonList; import static org.opensearch.rest.RestRequest.Method.DELETE; +/** + * Transport action to delete stored script + * + * @opensearch.api + */ public class RestDeleteStoredScriptAction extends BaseRestHandler { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestDeleteStoredScriptAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestGetRepositoriesAction.java b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestGetRepositoriesAction.java index 780d9266549..0eab9c1aaa6 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestGetRepositoriesAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestGetRepositoriesAction.java @@ -53,6 +53,8 @@ import static org.opensearch.rest.RestRequest.Method.GET; /** * Returns repository information + * + * @opensearch.api */ public class RestGetRepositoriesAction extends BaseRestHandler { diff --git a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestGetScriptContextAction.java b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestGetScriptContextAction.java index bc619b31a1d..5111397316b 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestGetScriptContextAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestGetScriptContextAction.java @@ -45,6 +45,11 @@ import java.util.List; import static java.util.Collections.singletonList; import static org.opensearch.rest.RestRequest.Method.GET; +/** + * Transport action to get script context + * + * @opensearch.api + */ public class RestGetScriptContextAction extends BaseRestHandler { @Override diff --git a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestGetScriptLanguageAction.java b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestGetScriptLanguageAction.java index 4066781e8bb..eacb9052cca 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestGetScriptLanguageAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestGetScriptLanguageAction.java @@ -45,6 +45,11 @@ import java.util.List; import static java.util.Collections.singletonList; import static org.opensearch.rest.RestRequest.Method.GET; +/** + * Transport action to get script language + * + * @opensearch.api + */ public class RestGetScriptLanguageAction extends BaseRestHandler { @Override diff --git a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestGetSnapshotsAction.java b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestGetSnapshotsAction.java index 189795516ad..dfaecddcf1d 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestGetSnapshotsAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestGetSnapshotsAction.java @@ -49,6 +49,8 @@ import static org.opensearch.rest.RestRequest.Method.GET; /** * Returns information about snapshot + * + * @opensearch.api */ public class RestGetSnapshotsAction extends BaseRestHandler { diff --git a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestGetStoredScriptAction.java b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestGetStoredScriptAction.java index 5a904b99be4..60302255bb5 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestGetStoredScriptAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestGetStoredScriptAction.java @@ -44,6 +44,11 @@ import java.util.List; import static java.util.Collections.singletonList; import static org.opensearch.rest.RestRequest.Method.GET; +/** + * Transport action to get stored script + * + * @opensearch.api + */ public class RestGetStoredScriptAction extends BaseRestHandler { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestGetStoredScriptAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestGetTaskAction.java b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestGetTaskAction.java index 39ed666e716..963ab43acef 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestGetTaskAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestGetTaskAction.java @@ -46,6 +46,11 @@ import java.util.List; import static java.util.Collections.singletonList; import static org.opensearch.rest.RestRequest.Method.GET; +/** + * Transport action to get task + * + * @opensearch.api + */ public class RestGetTaskAction extends BaseRestHandler { @Override diff --git a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestListTasksAction.java b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestListTasksAction.java index 058a822ab5f..cb255b3dd2f 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestListTasksAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestListTasksAction.java @@ -57,6 +57,11 @@ import java.util.function.Supplier; import static java.util.Collections.singletonList; import static org.opensearch.rest.RestRequest.Method.GET; +/** + * Transport action to list tasks + * + * @opensearch.api + */ public class RestListTasksAction extends BaseRestHandler { private final Supplier nodesInCluster; diff --git a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestNodesHotThreadsAction.java b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestNodesHotThreadsAction.java index 880791d2fb7..3c9321a8aba 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestNodesHotThreadsAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestNodesHotThreadsAction.java @@ -53,6 +53,11 @@ import static java.util.Arrays.asList; import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.GET; +/** + * Transport action to get hot threads + * + * @opensearch.api + */ public class RestNodesHotThreadsAction extends BaseRestHandler { private static final String formatDeprecatedMessageWithoutNodeID = "[%s] is a deprecated endpoint. " diff --git a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestNodesInfoAction.java b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestNodesInfoAction.java index dbb3ef68226..534ae087c0e 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestNodesInfoAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestNodesInfoAction.java @@ -50,6 +50,11 @@ import static java.util.Arrays.asList; import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.GET; +/** + * Transport action to get node info + * + * @opensearch.api + */ public class RestNodesInfoAction extends BaseRestHandler { static final Set ALLOWED_METRICS = NodesInfoRequest.Metric.allMetrics(); diff --git a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestNodesStatsAction.java b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestNodesStatsAction.java index 3c66b074053..c0e956fc419 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestNodesStatsAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestNodesStatsAction.java @@ -55,6 +55,11 @@ import static java.util.Arrays.asList; import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.GET; +/** + * Transport action to get nodes stats + * + * @opensearch.api + */ public class RestNodesStatsAction extends BaseRestHandler { @Override diff --git a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestNodesUsageAction.java b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestNodesUsageAction.java index f873a963ace..bfa4181cb6e 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestNodesUsageAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestNodesUsageAction.java @@ -54,6 +54,11 @@ import static java.util.Arrays.asList; import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.GET; +/** + * Transport action to get nodes usage + * + * @opensearch.api + */ public class RestNodesUsageAction extends BaseRestHandler { @Override diff --git a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestPendingClusterTasksAction.java b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestPendingClusterTasksAction.java index 155adc8cc7e..1158058c187 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestPendingClusterTasksAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestPendingClusterTasksAction.java @@ -45,6 +45,11 @@ import java.util.List; import static java.util.Collections.singletonList; import static org.opensearch.rest.RestRequest.Method.GET; +/** + * Transport action to get pending cluster tasks + * + * @opensearch.api + */ public class RestPendingClusterTasksAction extends BaseRestHandler { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestPendingClusterTasksAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestPutRepositoryAction.java b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestPutRepositoryAction.java index a1f34294d63..e64850c61f9 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestPutRepositoryAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestPutRepositoryAction.java @@ -51,6 +51,8 @@ import static org.opensearch.rest.RestRequest.Method.PUT; /** * Registers repositories + * + * @opensearch.api */ public class RestPutRepositoryAction extends BaseRestHandler { diff --git a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestPutStoredScriptAction.java b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestPutStoredScriptAction.java index 1568a80278b..f88cc6ede50 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestPutStoredScriptAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestPutStoredScriptAction.java @@ -49,6 +49,11 @@ import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.POST; import static org.opensearch.rest.RestRequest.Method.PUT; +/** + * Transport action to put stored script + * + * @opensearch.api + */ public class RestPutStoredScriptAction extends BaseRestHandler { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestPutStoredScriptAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestReloadSecureSettingsAction.java b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestReloadSecureSettingsAction.java index 2d5db335ef9..5d8312d9fa2 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestReloadSecureSettingsAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestReloadSecureSettingsAction.java @@ -59,6 +59,11 @@ import static java.util.Arrays.asList; import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.POST; +/** + * Transport action to reload secure settings + * + * @opensearch.api + */ public final class RestReloadSecureSettingsAction extends BaseRestHandler implements RestRequestFilter { static final ObjectParser PARSER = new ObjectParser<>( diff --git a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestRemoteClusterInfoAction.java b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestRemoteClusterInfoAction.java index ea6b0cd79ea..28edba4db38 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestRemoteClusterInfoAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestRemoteClusterInfoAction.java @@ -44,6 +44,11 @@ import java.util.List; import static java.util.Collections.singletonList; import static org.opensearch.rest.RestRequest.Method.GET; +/** + * Transport action to get remote cluster information + * + * @opensearch.api + */ public final class RestRemoteClusterInfoAction extends BaseRestHandler { @Override diff --git a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestRestoreSnapshotAction.java b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestRestoreSnapshotAction.java index 6c607b48a89..c56fc299368 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestRestoreSnapshotAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestRestoreSnapshotAction.java @@ -48,6 +48,8 @@ import static org.opensearch.rest.RestRequest.Method.POST; /** * Restores a snapshot + * + * @opensearch.api */ public class RestRestoreSnapshotAction extends BaseRestHandler { diff --git a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestSnapshotsStatusAction.java b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestSnapshotsStatusAction.java index 469c1eac348..d10703792dc 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestSnapshotsStatusAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestSnapshotsStatusAction.java @@ -50,6 +50,8 @@ import static org.opensearch.rest.RestRequest.Method.GET; /** * Returns status of currently running snapshot + * + * @opensearch.api */ public class RestSnapshotsStatusAction extends BaseRestHandler { diff --git a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestVerifyRepositoryAction.java b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestVerifyRepositoryAction.java index 4792d0e6db1..c759b5b8b7f 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestVerifyRepositoryAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/cluster/RestVerifyRepositoryAction.java @@ -46,6 +46,11 @@ import static java.util.Collections.singletonList; import static org.opensearch.client.Requests.verifyRepositoryRequest; import static org.opensearch.rest.RestRequest.Method.POST; +/** + * Transport action to verify a repository + * + * @opensearch.api + */ public class RestVerifyRepositoryAction extends BaseRestHandler { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestVerifyRepositoryAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/admin/cluster/dangling/RestDeleteDanglingIndexAction.java b/server/src/main/java/org/opensearch/rest/action/admin/cluster/dangling/RestDeleteDanglingIndexAction.java index 3e8883058d1..d3ac05ddf8f 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/cluster/dangling/RestDeleteDanglingIndexAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/cluster/dangling/RestDeleteDanglingIndexAction.java @@ -48,6 +48,11 @@ import static java.util.Collections.singletonList; import static org.opensearch.rest.RestRequest.Method.DELETE; import static org.opensearch.rest.RestStatus.ACCEPTED; +/** + * Transport action to delete dangling index + * + * @opensearch.api + */ public class RestDeleteDanglingIndexAction extends BaseRestHandler { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestDeleteDanglingIndexAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/admin/cluster/dangling/RestImportDanglingIndexAction.java b/server/src/main/java/org/opensearch/rest/action/admin/cluster/dangling/RestImportDanglingIndexAction.java index 5a48159bd96..85aa973d163 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/cluster/dangling/RestImportDanglingIndexAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/cluster/dangling/RestImportDanglingIndexAction.java @@ -48,6 +48,11 @@ import org.opensearch.rest.RestRequest; import org.opensearch.rest.RestStatus; import org.opensearch.rest.action.RestToXContentListener; +/** + * Transport action to import dangling index + * + * @opensearch.api + */ public class RestImportDanglingIndexAction extends BaseRestHandler { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestImportDanglingIndexAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/admin/cluster/dangling/RestListDanglingIndicesAction.java b/server/src/main/java/org/opensearch/rest/action/admin/cluster/dangling/RestListDanglingIndicesAction.java index 13b13ac29ce..c7c18fdf3f0 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/cluster/dangling/RestListDanglingIndicesAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/cluster/dangling/RestListDanglingIndicesAction.java @@ -44,6 +44,11 @@ import java.util.List; import static java.util.Collections.singletonList; import static org.opensearch.rest.RestRequest.Method.GET; +/** + * Transport action to list dangling index + * + * @opensearch.api + */ public class RestListDanglingIndicesAction extends BaseRestHandler { @Override public List routes() { diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/AliasesNotFoundException.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/AliasesNotFoundException.java index dc86cb36078..595b6a4b2ed 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/AliasesNotFoundException.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/AliasesNotFoundException.java @@ -37,6 +37,11 @@ import org.opensearch.common.io.stream.StreamInput; import java.io.IOException; import java.util.Arrays; +/** + * Exception thrown if an alias is not found + * + * @opensearch.api + */ public class AliasesNotFoundException extends ResourceNotFoundException { public AliasesNotFoundException(String... names) { diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestAddIndexBlockAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestAddIndexBlockAction.java index 6854662e3bb..3247832a2fa 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestAddIndexBlockAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestAddIndexBlockAction.java @@ -48,6 +48,11 @@ import java.util.List; import static org.opensearch.rest.RestRequest.Method.PUT; +/** + * Transport action to add index block + * + * @opensearch.api + */ public class RestAddIndexBlockAction extends BaseRestHandler { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestAddIndexBlockAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestAnalyzeAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestAnalyzeAction.java index f5b8ad7bb18..f61cf8ddbbd 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestAnalyzeAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestAnalyzeAction.java @@ -47,6 +47,11 @@ import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.GET; import static org.opensearch.rest.RestRequest.Method.POST; +/** + * Transport action to analyze an action + * + * @opensearch.api + */ public class RestAnalyzeAction extends BaseRestHandler { public static class Fields { diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestClearIndicesCacheAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestClearIndicesCacheAction.java index 603786c99a2..e4f0d7d006d 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestClearIndicesCacheAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestClearIndicesCacheAction.java @@ -47,6 +47,11 @@ import static java.util.Arrays.asList; import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.POST; +/** + * Transport action to clear indices cache + * + * @opensearch.api + */ public class RestClearIndicesCacheAction extends BaseRestHandler { @Override diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestCloseIndexAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestCloseIndexAction.java index 168d553112f..ceb6e929844 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestCloseIndexAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestCloseIndexAction.java @@ -49,6 +49,11 @@ import static java.util.Arrays.asList; import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.POST; +/** + * Transport action to close index + * + * @opensearch.api + */ public class RestCloseIndexAction extends BaseRestHandler { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestCloseIndexAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestCreateDataStreamAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestCreateDataStreamAction.java index 92662bb78e2..a65665b9913 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestCreateDataStreamAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestCreateDataStreamAction.java @@ -41,6 +41,11 @@ import java.io.IOException; import java.util.Collections; import java.util.List; +/** + * Transport action to create a data stream + * + * @opensearch.api + */ public class RestCreateDataStreamAction extends BaseRestHandler { @Override diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestCreateIndexAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestCreateIndexAction.java index 54199b8e685..8d781487765 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestCreateIndexAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestCreateIndexAction.java @@ -52,6 +52,11 @@ import static java.util.Collections.singletonList; import static java.util.Collections.singletonMap; import static org.opensearch.rest.RestRequest.Method.PUT; +/** + * Transport action to create an index + * + * @opensearch.api + */ public class RestCreateIndexAction extends BaseRestHandler { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestIndexPutAliasAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestDataStreamsStatsAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestDataStreamsStatsAction.java index 2c7f27c5515..741be5c5ffc 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestDataStreamsStatsAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestDataStreamsStatsAction.java @@ -44,6 +44,11 @@ import java.io.IOException; import java.util.Arrays; import java.util.List; +/** + * Transport action to get data stream stats + * + * @opensearch.api + */ public class RestDataStreamsStatsAction extends BaseRestHandler { @Override public String getName() { diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestDeleteComponentTemplateAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestDeleteComponentTemplateAction.java index 05656cb2505..d59dbff9681 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestDeleteComponentTemplateAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestDeleteComponentTemplateAction.java @@ -45,6 +45,11 @@ import java.util.List; import static org.opensearch.rest.RestRequest.Method.DELETE; +/** + * Transport action to delete component template + * + * @opensearch.api + */ public class RestDeleteComponentTemplateAction extends BaseRestHandler { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestDeleteComponentTemplateAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestDeleteComposableIndexTemplateAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestDeleteComposableIndexTemplateAction.java index b0828859351..a1a5dd30f3a 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestDeleteComposableIndexTemplateAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestDeleteComposableIndexTemplateAction.java @@ -45,6 +45,11 @@ import java.util.List; import static org.opensearch.rest.RestRequest.Method.DELETE; +/** + * Transport action to delete composable index template + * + * @opensearch.api + */ public class RestDeleteComposableIndexTemplateAction extends BaseRestHandler { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestDeleteComposableIndexTemplateAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestDeleteDataStreamAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestDeleteDataStreamAction.java index 40e1add973b..26656095116 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestDeleteDataStreamAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestDeleteDataStreamAction.java @@ -42,6 +42,11 @@ import java.io.IOException; import java.util.Collections; import java.util.List; +/** + * Transport action to delete data stream + * + * @opensearch.api + */ public class RestDeleteDataStreamAction extends BaseRestHandler { @Override diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestDeleteIndexAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestDeleteIndexAction.java index 63fa8a4b29d..418226f84ba 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestDeleteIndexAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestDeleteIndexAction.java @@ -48,6 +48,11 @@ import static java.util.Arrays.asList; import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.DELETE; +/** + * Transport action to delete index + * + * @opensearch.api + */ public class RestDeleteIndexAction extends BaseRestHandler { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestDeleteIndexAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestDeleteIndexTemplateAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestDeleteIndexTemplateAction.java index ce49332a4ab..9e8d15b2614 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestDeleteIndexTemplateAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestDeleteIndexTemplateAction.java @@ -44,6 +44,11 @@ import java.util.List; import static java.util.Collections.singletonList; import static org.opensearch.rest.RestRequest.Method.DELETE; +/** + * Transport action to delete index template + * + * @opensearch.api + */ public class RestDeleteIndexTemplateAction extends BaseRestHandler { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestDeleteIndexTemplateAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestFlushAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestFlushAction.java index 9fd88c0f455..03c91bced29 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestFlushAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestFlushAction.java @@ -48,6 +48,11 @@ import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.GET; import static org.opensearch.rest.RestRequest.Method.POST; +/** + * Transport action to flush + * + * @opensearch.api + */ public class RestFlushAction extends BaseRestHandler { @Override diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestForceMergeAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestForceMergeAction.java index 6e269922801..e684cd27570 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestForceMergeAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestForceMergeAction.java @@ -48,6 +48,11 @@ import static java.util.Arrays.asList; import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.POST; +/** + * Transport action to force merge + * + * @opensearch.api + */ public class RestForceMergeAction extends BaseRestHandler { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestForceMergeAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestGetAliasesAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestGetAliasesAction.java index 44e2ace0f7c..7f74db57bf5 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestGetAliasesAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestGetAliasesAction.java @@ -66,6 +66,8 @@ import static org.opensearch.rest.RestRequest.Method.HEAD; /** * The REST handler for get alias and head alias APIs. + * + * @opensearch.api */ public class RestGetAliasesAction extends BaseRestHandler { diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestGetComponentTemplateAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestGetComponentTemplateAction.java index e245c5a2084..34cb595c09d 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestGetComponentTemplateAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestGetComponentTemplateAction.java @@ -51,6 +51,11 @@ import static org.opensearch.rest.RestRequest.Method.HEAD; import static org.opensearch.rest.RestStatus.NOT_FOUND; import static org.opensearch.rest.RestStatus.OK; +/** + * Transport action to get component template + * + * @opensearch.api + */ public class RestGetComponentTemplateAction extends BaseRestHandler { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestGetComponentTemplateAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestGetComposableIndexTemplateAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestGetComposableIndexTemplateAction.java index d860e885657..c232d4b713a 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestGetComposableIndexTemplateAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestGetComposableIndexTemplateAction.java @@ -51,6 +51,11 @@ import static org.opensearch.rest.RestRequest.Method.HEAD; import static org.opensearch.rest.RestStatus.NOT_FOUND; import static org.opensearch.rest.RestStatus.OK; +/** + * Transport action to get composable index template + * + * @opensearch.api + */ public class RestGetComposableIndexTemplateAction extends BaseRestHandler { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestGetComposableIndexTemplateAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestGetDataStreamsAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestGetDataStreamsAction.java index 539ad671e5f..3cf27e324a3 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestGetDataStreamsAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestGetDataStreamsAction.java @@ -41,6 +41,11 @@ import org.opensearch.rest.action.RestToXContentListener; import java.io.IOException; import java.util.List; +/** + * Transport action to get data streams + * + * @opensearch.api + */ public class RestGetDataStreamsAction extends BaseRestHandler { @Override diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestGetFieldMappingAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestGetFieldMappingAction.java index c35f4177953..dce688f32d0 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestGetFieldMappingAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestGetFieldMappingAction.java @@ -59,6 +59,11 @@ import static org.opensearch.rest.RestRequest.Method.GET; import static org.opensearch.rest.RestStatus.NOT_FOUND; import static org.opensearch.rest.RestStatus.OK; +/** + * Transport action to get field mapping + * + * @opensearch.api + */ public class RestGetFieldMappingAction extends BaseRestHandler { private static final Logger logger = LogManager.getLogger(RestGetFieldMappingAction.class); private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(logger.getName()); diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestGetIndexTemplateAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestGetIndexTemplateAction.java index cda29d2b0ad..e938fe78a5b 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestGetIndexTemplateAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestGetIndexTemplateAction.java @@ -56,6 +56,8 @@ import static org.opensearch.rest.RestStatus.OK; /** * The REST handler for get template and head template APIs. + * + * @opensearch.api */ public class RestGetIndexTemplateAction extends BaseRestHandler { diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestGetIndicesAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestGetIndicesAction.java index c94d691d4e9..ec87ff43bf6 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestGetIndicesAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestGetIndicesAction.java @@ -53,6 +53,8 @@ import static org.opensearch.rest.RestRequest.Method.HEAD; /** * The REST handler for get index and head index APIs. + * + * @opensearch.api */ public class RestGetIndicesAction extends BaseRestHandler { diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestGetMappingAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestGetMappingAction.java index 86bf6b626c2..14e7c52f4b1 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestGetMappingAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestGetMappingAction.java @@ -59,6 +59,11 @@ import static java.util.Arrays.asList; import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.GET; +/** + * Transport action to get mapping + * + * @opensearch.api + */ public class RestGetMappingAction extends BaseRestHandler { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestGetMappingAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestGetSettingsAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestGetSettingsAction.java index 293078b3568..ded098ab27f 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestGetSettingsAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestGetSettingsAction.java @@ -48,6 +48,11 @@ import static java.util.Arrays.asList; import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.GET; +/** + * Transport action to get settings + * + * @opensearch.api + */ public class RestGetSettingsAction extends BaseRestHandler { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestGetSettingsAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestIndexDeleteAliasesAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestIndexDeleteAliasesAction.java index 9f0b543a456..e8c30895ae8 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestIndexDeleteAliasesAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestIndexDeleteAliasesAction.java @@ -47,6 +47,11 @@ import static java.util.Arrays.asList; import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.DELETE; +/** + * Transport action to delete index aliases + * + * @opensearch.api + */ public class RestIndexDeleteAliasesAction extends BaseRestHandler { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestIndexPutAliasAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestIndexPutAliasAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestIndexPutAliasAction.java index 8f8eeaf1c8e..2c6b3d36048 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestIndexPutAliasAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestIndexPutAliasAction.java @@ -50,6 +50,11 @@ import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.POST; import static org.opensearch.rest.RestRequest.Method.PUT; +/** + * Transport action to put alias(es) + * + * @opensearch.api + */ public class RestIndexPutAliasAction extends BaseRestHandler { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestIndexPutAliasAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestIndicesAliasesAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestIndicesAliasesAction.java index 20b67fa73a3..691fb316871 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestIndicesAliasesAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestIndicesAliasesAction.java @@ -46,6 +46,11 @@ import java.util.List; import static java.util.Collections.singletonList; import static org.opensearch.rest.RestRequest.Method.POST; +/** + * Transport action to list alias(es) + * + * @opensearch.api + */ public class RestIndicesAliasesAction extends BaseRestHandler { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestIndicesAliasesAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestIndicesSegmentsAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestIndicesSegmentsAction.java index c635c8928ba..3906c48295b 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestIndicesSegmentsAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestIndicesSegmentsAction.java @@ -47,6 +47,11 @@ import static java.util.Arrays.asList; import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.GET; +/** + * Transport action to get segment information + * + * @opensearch.api + */ public class RestIndicesSegmentsAction extends BaseRestHandler { @Override diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestIndicesShardStoresAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestIndicesShardStoresAction.java index 6030fad4e85..7f6ba57f5d5 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestIndicesShardStoresAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestIndicesShardStoresAction.java @@ -55,6 +55,8 @@ import static org.opensearch.rest.RestStatus.OK; /** * Rest action for {@link IndicesShardStoresAction} + * + * @opensearch.api */ public class RestIndicesShardStoresAction extends BaseRestHandler { diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestIndicesStatsAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestIndicesStatsAction.java index eabe14a7614..ba1407b36bf 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestIndicesStatsAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestIndicesStatsAction.java @@ -56,6 +56,11 @@ import static java.util.Arrays.asList; import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.GET; +/** + * Transport action to get indices stats + * + * @opensearch.api + */ public class RestIndicesStatsAction extends BaseRestHandler { @Override diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestOpenIndexAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestOpenIndexAction.java index a6d434b1e86..eda632ed098 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestOpenIndexAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestOpenIndexAction.java @@ -49,6 +49,11 @@ import static java.util.Arrays.asList; import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.POST; +/** + * Transport action to open an index + * + * @opensearch.api + */ public class RestOpenIndexAction extends BaseRestHandler { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestOpenIndexAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestPutComponentTemplateAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestPutComponentTemplateAction.java index 0d956b4dd14..12bf30c48d6 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestPutComponentTemplateAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestPutComponentTemplateAction.java @@ -47,6 +47,11 @@ import java.util.List; import static org.opensearch.rest.RestRequest.Method.POST; import static org.opensearch.rest.RestRequest.Method.PUT; +/** + * Transport action to put component template + * + * @opensearch.api + */ public class RestPutComponentTemplateAction extends BaseRestHandler { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestPutComponentTemplateAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestPutComposableIndexTemplateAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestPutComposableIndexTemplateAction.java index 63352a73b28..6c44a2c2eb6 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestPutComposableIndexTemplateAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestPutComposableIndexTemplateAction.java @@ -47,6 +47,11 @@ import java.util.List; import static org.opensearch.rest.RestRequest.Method.POST; import static org.opensearch.rest.RestRequest.Method.PUT; +/** + * Transport action to put composable index templates + * + * @opensearch.api + */ public class RestPutComposableIndexTemplateAction extends BaseRestHandler { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestPutComposableIndexTemplateAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestPutIndexTemplateAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestPutIndexTemplateAction.java index 42cd8e8103a..a4184cc1dbd 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestPutIndexTemplateAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestPutIndexTemplateAction.java @@ -52,6 +52,11 @@ import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.POST; import static org.opensearch.rest.RestRequest.Method.PUT; +/** + * Transport action to put index template + * + * @opensearch.api + */ public class RestPutIndexTemplateAction extends BaseRestHandler { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestPutIndexTemplateAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestPutMappingAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestPutMappingAction.java index 5c305b7c750..d1c08b977cc 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestPutMappingAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestPutMappingAction.java @@ -53,6 +53,11 @@ import static org.opensearch.client.Requests.putMappingRequest; import static org.opensearch.rest.RestRequest.Method.POST; import static org.opensearch.rest.RestRequest.Method.PUT; +/** + * Transport action to put mapping + * + * @opensearch.api + */ public class RestPutMappingAction extends BaseRestHandler { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestPutMappingAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestRecoveryAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestRecoveryAction.java index 75e3bcc97c6..33c7b239e27 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestRecoveryAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestRecoveryAction.java @@ -49,6 +49,8 @@ import static org.opensearch.rest.RestRequest.Method.GET; /** * REST handler to report on index recoveries. + * + * @opensearch.api */ public class RestRecoveryAction extends BaseRestHandler { diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestRefreshAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestRefreshAction.java index 28acfce57e3..2dc4c280956 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestRefreshAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestRefreshAction.java @@ -50,6 +50,11 @@ import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.GET; import static org.opensearch.rest.RestRequest.Method.POST; +/** + * Transport action to refresh + * + * @opensearch.api + */ public class RestRefreshAction extends BaseRestHandler { @Override diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestResizeHandler.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestResizeHandler.java index 4168c7ad48e..50bd8c9d1aa 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestResizeHandler.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestResizeHandler.java @@ -53,6 +53,11 @@ import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.POST; import static org.opensearch.rest.RestRequest.Method.PUT; +/** + * Transport handler to resize indices + * + * @opensearch.api + */ public abstract class RestResizeHandler extends BaseRestHandler { private static final Logger logger = LogManager.getLogger(RestResizeHandler.class); private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(logger.getName()); diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestResolveIndexAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestResolveIndexAction.java index c4d96ca7449..687ff554bd8 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestResolveIndexAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestResolveIndexAction.java @@ -43,6 +43,11 @@ import org.opensearch.rest.action.RestToXContentListener; import java.io.IOException; import java.util.List; +/** + * Transport action to resolve index + * + * @opensearch.api + */ public class RestResolveIndexAction extends BaseRestHandler { @Override diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestRolloverIndexAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestRolloverIndexAction.java index b9f8b936ff2..911e6654fd9 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestRolloverIndexAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestRolloverIndexAction.java @@ -47,6 +47,11 @@ import static java.util.Arrays.asList; import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.POST; +/** + * Transport action to rollover index + * + * @opensearch.api + */ public class RestRolloverIndexAction extends BaseRestHandler { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestRolloverIndexAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestSimulateIndexTemplateAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestSimulateIndexTemplateAction.java index fb78b7b0a82..5861a452d7f 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestSimulateIndexTemplateAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestSimulateIndexTemplateAction.java @@ -47,6 +47,11 @@ import java.util.List; import static org.opensearch.rest.RestRequest.Method.POST; +/** + * Transport action to simulate an index template + * + * @opensearch.api + */ public class RestSimulateIndexTemplateAction extends BaseRestHandler { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestSimulateIndexTemplateAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestSimulateTemplateAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestSimulateTemplateAction.java index 58cc0c1e369..3ebdc910338 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestSimulateTemplateAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestSimulateTemplateAction.java @@ -47,6 +47,11 @@ import java.util.List; import static org.opensearch.rest.RestRequest.Method.POST; +/** + * Transport action to simulate a template + * + * @opensearch.api + */ public class RestSimulateTemplateAction extends BaseRestHandler { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestSimulateTemplateAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestSyncedFlushAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestSyncedFlushAction.java index 726fd69dc29..8d67aab6c47 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestSyncedFlushAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestSyncedFlushAction.java @@ -55,6 +55,14 @@ import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.GET; import static org.opensearch.rest.RestRequest.Method.POST; +/** + * Transport action to execute a synced flush + * + * @opensearch.api + * + * @deprecated remove since synced flush is removed + */ +@Deprecated public class RestSyncedFlushAction extends BaseRestHandler { private static final DeprecationLogger DEPRECATION_LOGGER = DeprecationLogger.getLogger(RestSyncedFlushAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestUpdateSettingsAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestUpdateSettingsAction.java index bfb634d421f..a47a0943fa5 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestUpdateSettingsAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestUpdateSettingsAction.java @@ -51,6 +51,11 @@ import static java.util.Collections.unmodifiableList; import static org.opensearch.client.Requests.updateSettingsRequest; import static org.opensearch.rest.RestRequest.Method.PUT; +/** + * Transport action to update settings + * + * @opensearch.api + */ public class RestUpdateSettingsAction extends BaseRestHandler { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestUpdateSettingsAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestUpgradeAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestUpgradeAction.java index ba9dc765178..1c925f030f5 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestUpgradeAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestUpgradeAction.java @@ -47,6 +47,11 @@ import static java.util.Arrays.asList; import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.POST; +/** + * Transport action to upgrade an index + * + * @opensearch.api + */ public class RestUpgradeAction extends BaseRestHandler { @Override diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestUpgradeStatusAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestUpgradeStatusAction.java index d5582fa5c44..a05b52b7087 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestUpgradeStatusAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestUpgradeStatusAction.java @@ -47,6 +47,11 @@ import static java.util.Arrays.asList; import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.GET; +/** + * Transport action to get an upgrade status + * + * @opensearch.api + */ public class RestUpgradeStatusAction extends BaseRestHandler { @Override diff --git a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestValidateQueryAction.java b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestValidateQueryAction.java index bf300d5395b..19bb5593643 100644 --- a/server/src/main/java/org/opensearch/rest/action/admin/indices/RestValidateQueryAction.java +++ b/server/src/main/java/org/opensearch/rest/action/admin/indices/RestValidateQueryAction.java @@ -56,6 +56,11 @@ import static org.opensearch.rest.RestRequest.Method.GET; import static org.opensearch.rest.RestRequest.Method.POST; import static org.opensearch.rest.RestStatus.OK; +/** + * Transport action to validate a query + * + * @opensearch.api + */ public class RestValidateQueryAction extends BaseRestHandler { @Override public List routes() { diff --git a/server/src/main/java/org/opensearch/rest/action/cat/AbstractCatAction.java b/server/src/main/java/org/opensearch/rest/action/cat/AbstractCatAction.java index d82a32cfc2c..abc08b9318a 100644 --- a/server/src/main/java/org/opensearch/rest/action/cat/AbstractCatAction.java +++ b/server/src/main/java/org/opensearch/rest/action/cat/AbstractCatAction.java @@ -50,6 +50,11 @@ import java.util.Set; import static org.opensearch.rest.action.cat.RestTable.buildHelpWidths; import static org.opensearch.rest.action.cat.RestTable.pad; +/** + * Base Transport action class for _cat API + * + * @opensearch.api + */ public abstract class AbstractCatAction extends BaseRestHandler { protected abstract RestChannelConsumer doCatRequest(RestRequest request, NodeClient client); diff --git a/server/src/main/java/org/opensearch/rest/action/cat/RestAliasAction.java b/server/src/main/java/org/opensearch/rest/action/cat/RestAliasAction.java index 78e0134fe0b..7aa91c175db 100644 --- a/server/src/main/java/org/opensearch/rest/action/cat/RestAliasAction.java +++ b/server/src/main/java/org/opensearch/rest/action/cat/RestAliasAction.java @@ -49,6 +49,11 @@ import static java.util.Arrays.asList; import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.GET; +/** + * _cat API action to list aliases + * + * @opensearch.api + */ public class RestAliasAction extends AbstractCatAction { @Override diff --git a/server/src/main/java/org/opensearch/rest/action/cat/RestAllocationAction.java b/server/src/main/java/org/opensearch/rest/action/cat/RestAllocationAction.java index eb03b9e25a2..b9c414e320a 100644 --- a/server/src/main/java/org/opensearch/rest/action/cat/RestAllocationAction.java +++ b/server/src/main/java/org/opensearch/rest/action/cat/RestAllocationAction.java @@ -57,6 +57,11 @@ import static java.util.Arrays.asList; import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.GET; +/** + * _cat API action to list shard allocations + * + * @opensearch.api + */ public class RestAllocationAction extends AbstractCatAction { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestAllocationAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/cat/RestCatAction.java b/server/src/main/java/org/opensearch/rest/action/cat/RestCatAction.java index 2aaccdbdf6b..b0fd6dd03fe 100644 --- a/server/src/main/java/org/opensearch/rest/action/cat/RestCatAction.java +++ b/server/src/main/java/org/opensearch/rest/action/cat/RestCatAction.java @@ -44,6 +44,11 @@ import java.util.List; import static java.util.Collections.singletonList; import static org.opensearch.rest.RestRequest.Method.GET; +/** + * Base _cat API endpoint + * + * @opensearch.api + */ public class RestCatAction extends BaseRestHandler { private static final String CAT = "=^.^="; diff --git a/server/src/main/java/org/opensearch/rest/action/cat/RestCatRecoveryAction.java b/server/src/main/java/org/opensearch/rest/action/cat/RestCatRecoveryAction.java index 2dd7a2fddbf..f18ace99359 100644 --- a/server/src/main/java/org/opensearch/rest/action/cat/RestCatRecoveryAction.java +++ b/server/src/main/java/org/opensearch/rest/action/cat/RestCatRecoveryAction.java @@ -60,6 +60,8 @@ import static org.opensearch.rest.RestRequest.Method.GET; * RestRecoveryAction provides information about the status of replica recovery * in a string format, designed to be used at the command line. An Index can * be specified to limit output to a particular index or indices. + * + * @opensearch.api */ public class RestCatRecoveryAction extends AbstractCatAction { diff --git a/server/src/main/java/org/opensearch/rest/action/cat/RestCountAction.java b/server/src/main/java/org/opensearch/rest/action/cat/RestCountAction.java index 033c9a278ca..a35c0047a03 100644 --- a/server/src/main/java/org/opensearch/rest/action/cat/RestCountAction.java +++ b/server/src/main/java/org/opensearch/rest/action/cat/RestCountAction.java @@ -53,6 +53,11 @@ import static java.util.Arrays.asList; import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.GET; +/** + * _cat API action to count documents in an index + * + * @opensearch.api + */ public class RestCountAction extends AbstractCatAction { @Override diff --git a/server/src/main/java/org/opensearch/rest/action/cat/RestFielddataAction.java b/server/src/main/java/org/opensearch/rest/action/cat/RestFielddataAction.java index 02de5f73014..df70ee5943a 100644 --- a/server/src/main/java/org/opensearch/rest/action/cat/RestFielddataAction.java +++ b/server/src/main/java/org/opensearch/rest/action/cat/RestFielddataAction.java @@ -51,6 +51,8 @@ import static org.opensearch.rest.RestRequest.Method.GET; /** * Cat API class to display information about the size of fielddata fields per node + * + * @opensearch.api */ public class RestFielddataAction extends AbstractCatAction { diff --git a/server/src/main/java/org/opensearch/rest/action/cat/RestHealthAction.java b/server/src/main/java/org/opensearch/rest/action/cat/RestHealthAction.java index c05b0b9c771..717df832d5d 100644 --- a/server/src/main/java/org/opensearch/rest/action/cat/RestHealthAction.java +++ b/server/src/main/java/org/opensearch/rest/action/cat/RestHealthAction.java @@ -46,6 +46,11 @@ import java.util.Locale; import static java.util.Collections.singletonList; import static org.opensearch.rest.RestRequest.Method.GET; +/** + * _cat API action to get cluster health + * + * @opensearch.api + */ public class RestHealthAction extends AbstractCatAction { @Override diff --git a/server/src/main/java/org/opensearch/rest/action/cat/RestIndicesAction.java b/server/src/main/java/org/opensearch/rest/action/cat/RestIndicesAction.java index d6a620316f4..9df7fe3c8fe 100644 --- a/server/src/main/java/org/opensearch/rest/action/cat/RestIndicesAction.java +++ b/server/src/main/java/org/opensearch/rest/action/cat/RestIndicesAction.java @@ -81,6 +81,11 @@ import static java.util.Collections.unmodifiableList; import static org.opensearch.action.support.master.MasterNodeRequest.DEFAULT_MASTER_NODE_TIMEOUT; import static org.opensearch.rest.RestRequest.Method.GET; +/** + * _cat API action to list indices + * + * @opensearch.api + */ public class RestIndicesAction extends AbstractCatAction { private static final DateFormatter STRICT_DATE_TIME_FORMATTER = DateFormatter.forPattern("strict_date_time"); diff --git a/server/src/main/java/org/opensearch/rest/action/cat/RestMasterAction.java b/server/src/main/java/org/opensearch/rest/action/cat/RestMasterAction.java index 64103cba556..671777d643c 100644 --- a/server/src/main/java/org/opensearch/rest/action/cat/RestMasterAction.java +++ b/server/src/main/java/org/opensearch/rest/action/cat/RestMasterAction.java @@ -48,6 +48,11 @@ import java.util.List; import static java.util.Collections.singletonList; import static org.opensearch.rest.RestRequest.Method.GET; +/** + * _cat API action to list cluster_manager information + * + * @opensearch.api + */ public class RestMasterAction extends AbstractCatAction { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestMasterAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/cat/RestNodeAttrsAction.java b/server/src/main/java/org/opensearch/rest/action/cat/RestNodeAttrsAction.java index 6ea36267d39..e856c158436 100644 --- a/server/src/main/java/org/opensearch/rest/action/cat/RestNodeAttrsAction.java +++ b/server/src/main/java/org/opensearch/rest/action/cat/RestNodeAttrsAction.java @@ -55,6 +55,11 @@ import java.util.Map; import static java.util.Collections.singletonList; import static org.opensearch.rest.RestRequest.Method.GET; +/** + * _cat API action to get node attributes + * + * @opensearch.api + */ public class RestNodeAttrsAction extends AbstractCatAction { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestNodeAttrsAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/cat/RestNodesAction.java b/server/src/main/java/org/opensearch/rest/action/cat/RestNodesAction.java index 820031f9e57..661a53e3d37 100644 --- a/server/src/main/java/org/opensearch/rest/action/cat/RestNodesAction.java +++ b/server/src/main/java/org/opensearch/rest/action/cat/RestNodesAction.java @@ -82,6 +82,11 @@ import java.util.stream.Collectors; import static java.util.Collections.singletonList; import static org.opensearch.rest.RestRequest.Method.GET; +/** + * _cat API action to get node information + * + * @opensearch.api + */ public class RestNodesAction extends AbstractCatAction { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestNodesAction.class); static final String LOCAL_DEPRECATED_MESSAGE = "Deprecated parameter [local] used. This parameter does not cause this API to act " diff --git a/server/src/main/java/org/opensearch/rest/action/cat/RestPendingClusterTasksAction.java b/server/src/main/java/org/opensearch/rest/action/cat/RestPendingClusterTasksAction.java index 7e261510ee7..8ab324f8e37 100644 --- a/server/src/main/java/org/opensearch/rest/action/cat/RestPendingClusterTasksAction.java +++ b/server/src/main/java/org/opensearch/rest/action/cat/RestPendingClusterTasksAction.java @@ -47,6 +47,11 @@ import java.util.List; import static java.util.Collections.singletonList; import static org.opensearch.rest.RestRequest.Method.GET; +/** + * _cat API action to get pending cluster tasks + * + * @opensearch.api + */ public class RestPendingClusterTasksAction extends AbstractCatAction { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestPendingClusterTasksAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/cat/RestPluginsAction.java b/server/src/main/java/org/opensearch/rest/action/cat/RestPluginsAction.java index 8975c8ab4b3..0b2536a188c 100644 --- a/server/src/main/java/org/opensearch/rest/action/cat/RestPluginsAction.java +++ b/server/src/main/java/org/opensearch/rest/action/cat/RestPluginsAction.java @@ -54,6 +54,11 @@ import java.util.List; import static java.util.Collections.singletonList; import static org.opensearch.rest.RestRequest.Method.GET; +/** + * _cat API action to get plugin information + * + * @opensearch.api + */ public class RestPluginsAction extends AbstractCatAction { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestPluginsAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/cat/RestRepositoriesAction.java b/server/src/main/java/org/opensearch/rest/action/cat/RestRepositoriesAction.java index 76c71bee791..fb6ec9a035c 100644 --- a/server/src/main/java/org/opensearch/rest/action/cat/RestRepositoriesAction.java +++ b/server/src/main/java/org/opensearch/rest/action/cat/RestRepositoriesAction.java @@ -49,6 +49,8 @@ import static org.opensearch.rest.RestRequest.Method.GET; /** * Cat API class to display information about snapshot repositories + * + * @opensearch.api */ public class RestRepositoriesAction extends AbstractCatAction { diff --git a/server/src/main/java/org/opensearch/rest/action/cat/RestSegmentsAction.java b/server/src/main/java/org/opensearch/rest/action/cat/RestSegmentsAction.java index 3a31fdab125..72b159cb554 100644 --- a/server/src/main/java/org/opensearch/rest/action/cat/RestSegmentsAction.java +++ b/server/src/main/java/org/opensearch/rest/action/cat/RestSegmentsAction.java @@ -57,6 +57,11 @@ import static java.util.Arrays.asList; import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.GET; +/** + * _cat API action to get segments information + * + * @opensearch.api + */ public class RestSegmentsAction extends AbstractCatAction { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestSegmentsAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/cat/RestShardsAction.java b/server/src/main/java/org/opensearch/rest/action/cat/RestShardsAction.java index 32e2ca8481f..d20b2fb0401 100644 --- a/server/src/main/java/org/opensearch/rest/action/cat/RestShardsAction.java +++ b/server/src/main/java/org/opensearch/rest/action/cat/RestShardsAction.java @@ -74,6 +74,11 @@ import static java.util.Arrays.asList; import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.GET; +/** + * _cat API action to get shard information + * + * @opensearch.api + */ public class RestShardsAction extends AbstractCatAction { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestShardsAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/cat/RestSnapshotAction.java b/server/src/main/java/org/opensearch/rest/action/cat/RestSnapshotAction.java index 5adb9228d98..86bb8d983b5 100644 --- a/server/src/main/java/org/opensearch/rest/action/cat/RestSnapshotAction.java +++ b/server/src/main/java/org/opensearch/rest/action/cat/RestSnapshotAction.java @@ -56,6 +56,8 @@ import static org.opensearch.rest.RestRequest.Method.GET; /** * Cat API class to display information about snapshots + * + * @opensearch.api */ public class RestSnapshotAction extends AbstractCatAction { diff --git a/server/src/main/java/org/opensearch/rest/action/cat/RestTable.java b/server/src/main/java/org/opensearch/rest/action/cat/RestTable.java index 542c4289014..43f28218bdd 100644 --- a/server/src/main/java/org/opensearch/rest/action/cat/RestTable.java +++ b/server/src/main/java/org/opensearch/rest/action/cat/RestTable.java @@ -60,6 +60,11 @@ import java.util.Locale; import java.util.Map; import java.util.Set; +/** + * a REST table + * + * @opensearch.api + */ public class RestTable { public static RestResponse buildResponse(Table table, RestChannel channel) throws Exception { diff --git a/server/src/main/java/org/opensearch/rest/action/cat/RestTasksAction.java b/server/src/main/java/org/opensearch/rest/action/cat/RestTasksAction.java index a6624c2f8cf..d30086fb8cd 100644 --- a/server/src/main/java/org/opensearch/rest/action/cat/RestTasksAction.java +++ b/server/src/main/java/org/opensearch/rest/action/cat/RestTasksAction.java @@ -62,6 +62,11 @@ import static java.util.Collections.singletonList; import static org.opensearch.rest.RestRequest.Method.GET; import static org.opensearch.rest.action.admin.cluster.RestListTasksAction.generateListTasksRequest; +/** + * _cat API action to get tasks information + * + * @opensearch.api + */ public class RestTasksAction extends AbstractCatAction { private final Supplier nodesInCluster; diff --git a/server/src/main/java/org/opensearch/rest/action/cat/RestTemplatesAction.java b/server/src/main/java/org/opensearch/rest/action/cat/RestTemplatesAction.java index bedc57453cb..5c7310df1b6 100644 --- a/server/src/main/java/org/opensearch/rest/action/cat/RestTemplatesAction.java +++ b/server/src/main/java/org/opensearch/rest/action/cat/RestTemplatesAction.java @@ -53,6 +53,11 @@ import static java.util.Arrays.asList; import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.GET; +/** + * _cat API action to get template information + * + * @opensearch.api + */ public class RestTemplatesAction extends AbstractCatAction { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestTemplatesAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/cat/RestThreadPoolAction.java b/server/src/main/java/org/opensearch/rest/action/cat/RestThreadPoolAction.java index 2f43a3a66d0..bf95be3889a 100644 --- a/server/src/main/java/org/opensearch/rest/action/cat/RestThreadPoolAction.java +++ b/server/src/main/java/org/opensearch/rest/action/cat/RestThreadPoolAction.java @@ -67,6 +67,11 @@ import static java.util.Arrays.asList; import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.GET; +/** + * _cat API action to get threadpool information + * + * @opensearch.api + */ public class RestThreadPoolAction extends AbstractCatAction { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestThreadPoolAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/document/RestBulkAction.java b/server/src/main/java/org/opensearch/rest/action/document/RestBulkAction.java index c140514e3c9..3fc02db0a83 100644 --- a/server/src/main/java/org/opensearch/rest/action/document/RestBulkAction.java +++ b/server/src/main/java/org/opensearch/rest/action/document/RestBulkAction.java @@ -60,6 +60,8 @@ import static org.opensearch.rest.RestRequest.Method.PUT; * { "create" : { "_index" : "test", "_id" : "1" } * { "type1" : { "field1" : "value1" } } * + * + * @opensearch.api */ public class RestBulkAction extends BaseRestHandler { diff --git a/server/src/main/java/org/opensearch/rest/action/document/RestDeleteAction.java b/server/src/main/java/org/opensearch/rest/action/document/RestDeleteAction.java index f9f5933a44c..6b882369a88 100644 --- a/server/src/main/java/org/opensearch/rest/action/document/RestDeleteAction.java +++ b/server/src/main/java/org/opensearch/rest/action/document/RestDeleteAction.java @@ -48,6 +48,11 @@ import static java.util.Arrays.asList; import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.DELETE; +/** + * Transport action to delete a document + * + * @opensearch.api + */ public class RestDeleteAction extends BaseRestHandler { @Override diff --git a/server/src/main/java/org/opensearch/rest/action/document/RestGetAction.java b/server/src/main/java/org/opensearch/rest/action/document/RestGetAction.java index a0ec48ee554..87bec22ac2d 100644 --- a/server/src/main/java/org/opensearch/rest/action/document/RestGetAction.java +++ b/server/src/main/java/org/opensearch/rest/action/document/RestGetAction.java @@ -54,6 +54,11 @@ import static org.opensearch.rest.RestRequest.Method.HEAD; import static org.opensearch.rest.RestStatus.NOT_FOUND; import static org.opensearch.rest.RestStatus.OK; +/** + * Transport action to get a document + * + * @opensearch.api + */ public class RestGetAction extends BaseRestHandler { @Override diff --git a/server/src/main/java/org/opensearch/rest/action/document/RestGetSourceAction.java b/server/src/main/java/org/opensearch/rest/action/document/RestGetSourceAction.java index 801ab85039d..ecd97ceada0 100644 --- a/server/src/main/java/org/opensearch/rest/action/document/RestGetSourceAction.java +++ b/server/src/main/java/org/opensearch/rest/action/document/RestGetSourceAction.java @@ -60,6 +60,8 @@ import static org.opensearch.rest.RestStatus.OK; /** * The REST handler for get source and head source APIs. + * + * @opensearch.api */ public class RestGetSourceAction extends BaseRestHandler { diff --git a/server/src/main/java/org/opensearch/rest/action/document/RestIndexAction.java b/server/src/main/java/org/opensearch/rest/action/document/RestIndexAction.java index 75f3967c32b..ba3558f6fe8 100644 --- a/server/src/main/java/org/opensearch/rest/action/document/RestIndexAction.java +++ b/server/src/main/java/org/opensearch/rest/action/document/RestIndexAction.java @@ -54,6 +54,11 @@ import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.POST; import static org.opensearch.rest.RestRequest.Method.PUT; +/** + * Transport action to index a document + * + * @opensearch.api + */ public class RestIndexAction extends BaseRestHandler { @Override diff --git a/server/src/main/java/org/opensearch/rest/action/document/RestMultiGetAction.java b/server/src/main/java/org/opensearch/rest/action/document/RestMultiGetAction.java index 6713bddfd83..e676cdf6f1b 100644 --- a/server/src/main/java/org/opensearch/rest/action/document/RestMultiGetAction.java +++ b/server/src/main/java/org/opensearch/rest/action/document/RestMultiGetAction.java @@ -50,6 +50,11 @@ import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.GET; import static org.opensearch.rest.RestRequest.Method.POST; +/** + * Transport action to perform a multi get + * + * @opensearch.api + */ public class RestMultiGetAction extends BaseRestHandler { private final boolean allowExplicitIndex; diff --git a/server/src/main/java/org/opensearch/rest/action/document/RestMultiTermVectorsAction.java b/server/src/main/java/org/opensearch/rest/action/document/RestMultiTermVectorsAction.java index 66b0c004b9f..c453094f331 100644 --- a/server/src/main/java/org/opensearch/rest/action/document/RestMultiTermVectorsAction.java +++ b/server/src/main/java/org/opensearch/rest/action/document/RestMultiTermVectorsAction.java @@ -48,6 +48,11 @@ import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.GET; import static org.opensearch.rest.RestRequest.Method.POST; +/** + * Transport action to get a multi term vector + * + * @opensearch.api + */ public class RestMultiTermVectorsAction extends BaseRestHandler { @Override diff --git a/server/src/main/java/org/opensearch/rest/action/document/RestTermVectorsAction.java b/server/src/main/java/org/opensearch/rest/action/document/RestTermVectorsAction.java index 727b9047408..e2b14629e75 100644 --- a/server/src/main/java/org/opensearch/rest/action/document/RestTermVectorsAction.java +++ b/server/src/main/java/org/opensearch/rest/action/document/RestTermVectorsAction.java @@ -55,6 +55,8 @@ import static org.opensearch.rest.RestRequest.Method.POST; /** * This class parses the json request and translates it into a * TermVectorsRequest. + * + * @opensearch.api */ public class RestTermVectorsAction extends BaseRestHandler { public static final String TYPES_DEPRECATION_MESSAGE = "[types removal] " + "Specifying types in term vector requests is deprecated."; diff --git a/server/src/main/java/org/opensearch/rest/action/document/RestUpdateAction.java b/server/src/main/java/org/opensearch/rest/action/document/RestUpdateAction.java index 832d8da4a8f..b3683e7b49f 100644 --- a/server/src/main/java/org/opensearch/rest/action/document/RestUpdateAction.java +++ b/server/src/main/java/org/opensearch/rest/action/document/RestUpdateAction.java @@ -52,6 +52,11 @@ import static java.util.Arrays.asList; import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.POST; +/** + * Transport action to update a document + * + * @opensearch.api + */ public class RestUpdateAction extends BaseRestHandler { @Override diff --git a/server/src/main/java/org/opensearch/rest/action/ingest/RestDeletePipelineAction.java b/server/src/main/java/org/opensearch/rest/action/ingest/RestDeletePipelineAction.java index 69f9316bc3d..0248110c467 100644 --- a/server/src/main/java/org/opensearch/rest/action/ingest/RestDeletePipelineAction.java +++ b/server/src/main/java/org/opensearch/rest/action/ingest/RestDeletePipelineAction.java @@ -45,6 +45,11 @@ import java.util.List; import static java.util.Collections.singletonList; import static org.opensearch.rest.RestRequest.Method.DELETE; +/** + * Transport action to delete an ingest pipeline + * + * @opensearch.api + */ public class RestDeletePipelineAction extends BaseRestHandler { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestDeletePipelineAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/ingest/RestGetPipelineAction.java b/server/src/main/java/org/opensearch/rest/action/ingest/RestGetPipelineAction.java index 5555bf53a5e..e9335f4ce36 100644 --- a/server/src/main/java/org/opensearch/rest/action/ingest/RestGetPipelineAction.java +++ b/server/src/main/java/org/opensearch/rest/action/ingest/RestGetPipelineAction.java @@ -47,6 +47,11 @@ import static java.util.Arrays.asList; import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.GET; +/** + * Transport action to get an ingest pipeline + * + * @opensearch.api + */ public class RestGetPipelineAction extends BaseRestHandler { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestGetPipelineAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/ingest/RestPutPipelineAction.java b/server/src/main/java/org/opensearch/rest/action/ingest/RestPutPipelineAction.java index 8a9abc860fb..a94dd18dbf8 100644 --- a/server/src/main/java/org/opensearch/rest/action/ingest/RestPutPipelineAction.java +++ b/server/src/main/java/org/opensearch/rest/action/ingest/RestPutPipelineAction.java @@ -48,6 +48,11 @@ import java.util.List; import static java.util.Collections.singletonList; import static org.opensearch.rest.RestRequest.Method.PUT; +/** + * Transport action to put a pipeline + * + * @opensearch.api + */ public class RestPutPipelineAction extends BaseRestHandler { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestPutPipelineAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/ingest/RestSimulatePipelineAction.java b/server/src/main/java/org/opensearch/rest/action/ingest/RestSimulatePipelineAction.java index 1f8d9edce6e..eb193edda33 100644 --- a/server/src/main/java/org/opensearch/rest/action/ingest/RestSimulatePipelineAction.java +++ b/server/src/main/java/org/opensearch/rest/action/ingest/RestSimulatePipelineAction.java @@ -49,6 +49,11 @@ import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.GET; import static org.opensearch.rest.RestRequest.Method.POST; +/** + * Transport action to simulate an ingest pipeline + * + * @opensearch.api + */ public class RestSimulatePipelineAction extends BaseRestHandler { @Override diff --git a/server/src/main/java/org/opensearch/rest/action/search/RestClearScrollAction.java b/server/src/main/java/org/opensearch/rest/action/search/RestClearScrollAction.java index 6bdbb470338..b9f57feab42 100644 --- a/server/src/main/java/org/opensearch/rest/action/search/RestClearScrollAction.java +++ b/server/src/main/java/org/opensearch/rest/action/search/RestClearScrollAction.java @@ -46,6 +46,11 @@ import static java.util.Arrays.asList; import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.DELETE; +/** + * Transport action to clear a scroll + * + * @opensearch.api + */ public class RestClearScrollAction extends BaseRestHandler { @Override diff --git a/server/src/main/java/org/opensearch/rest/action/search/RestCountAction.java b/server/src/main/java/org/opensearch/rest/action/search/RestCountAction.java index 6cb00633de4..a4a8b2c3b5e 100644 --- a/server/src/main/java/org/opensearch/rest/action/search/RestCountAction.java +++ b/server/src/main/java/org/opensearch/rest/action/search/RestCountAction.java @@ -57,6 +57,11 @@ import static org.opensearch.rest.RestRequest.Method.POST; import static org.opensearch.rest.action.RestActions.buildBroadcastShardsHeader; import static org.opensearch.search.internal.SearchContext.DEFAULT_TERMINATE_AFTER; +/** + * Transport action to count documents + * + * @opensearch.api + */ public class RestCountAction extends BaseRestHandler { @Override diff --git a/server/src/main/java/org/opensearch/rest/action/search/RestExplainAction.java b/server/src/main/java/org/opensearch/rest/action/search/RestExplainAction.java index 2b73e145cf5..bf29e0edfd2 100644 --- a/server/src/main/java/org/opensearch/rest/action/search/RestExplainAction.java +++ b/server/src/main/java/org/opensearch/rest/action/search/RestExplainAction.java @@ -52,6 +52,8 @@ import static org.opensearch.rest.RestRequest.Method.POST; /** * Rest action for computing a score explanation for specific documents. + * + * @opensearch.api */ public class RestExplainAction extends BaseRestHandler { diff --git a/server/src/main/java/org/opensearch/rest/action/search/RestMultiSearchAction.java b/server/src/main/java/org/opensearch/rest/action/search/RestMultiSearchAction.java index 8262f8199a7..c5af10e5ce6 100644 --- a/server/src/main/java/org/opensearch/rest/action/search/RestMultiSearchAction.java +++ b/server/src/main/java/org/opensearch/rest/action/search/RestMultiSearchAction.java @@ -66,6 +66,11 @@ import static java.util.Collections.unmodifiableList; import static org.opensearch.rest.RestRequest.Method.GET; import static org.opensearch.rest.RestRequest.Method.POST; +/** + * Transport action to perform a multi search + * + * @opensearch.api + */ public class RestMultiSearchAction extends BaseRestHandler { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RestMultiSearchAction.class); diff --git a/server/src/main/java/org/opensearch/rest/action/search/RestSearchAction.java b/server/src/main/java/org/opensearch/rest/action/search/RestSearchAction.java index b8420040746..2db131723bc 100644 --- a/server/src/main/java/org/opensearch/rest/action/search/RestSearchAction.java +++ b/server/src/main/java/org/opensearch/rest/action/search/RestSearchAction.java @@ -74,6 +74,11 @@ import static org.opensearch.rest.RestRequest.Method.GET; import static org.opensearch.rest.RestRequest.Method.POST; import static org.opensearch.search.suggest.SuggestBuilders.termSuggestion; +/** + * Transport action to perform a search + * + * @opensearch.api + */ public class RestSearchAction extends BaseRestHandler { /** * Indicates whether hits.total should be rendered as an integer or an object diff --git a/server/src/main/java/org/opensearch/rest/action/search/RestSearchScrollAction.java b/server/src/main/java/org/opensearch/rest/action/search/RestSearchScrollAction.java index bb725c35e87..28dc5f64763 100644 --- a/server/src/main/java/org/opensearch/rest/action/search/RestSearchScrollAction.java +++ b/server/src/main/java/org/opensearch/rest/action/search/RestSearchScrollAction.java @@ -50,6 +50,11 @@ import static org.opensearch.common.unit.TimeValue.parseTimeValue; import static org.opensearch.rest.RestRequest.Method.GET; import static org.opensearch.rest.RestRequest.Method.POST; +/** + * Transport action to perform a search scroll + * + * @opensearch.api + */ public class RestSearchScrollAction extends BaseRestHandler { private static final Set RESPONSE_PARAMS = Collections.singleton(RestSearchAction.TOTAL_HITS_AS_INT_PARAM); diff --git a/server/src/main/java/org/opensearch/script/AbstractSortScript.java b/server/src/main/java/org/opensearch/script/AbstractSortScript.java index d1a1b321b0a..c72717f8bc9 100644 --- a/server/src/main/java/org/opensearch/script/AbstractSortScript.java +++ b/server/src/main/java/org/opensearch/script/AbstractSortScript.java @@ -46,6 +46,11 @@ import java.util.HashMap; import java.util.Map; import java.util.function.Function; +/** + * Base sort script + * + * @opensearch.internal + */ abstract class AbstractSortScript implements ScorerAware { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(DynamicMap.class); diff --git a/server/src/main/java/org/opensearch/snapshots/AbortedSnapshotException.java b/server/src/main/java/org/opensearch/snapshots/AbortedSnapshotException.java index 6aa75ee49bd..930d9408552 100644 --- a/server/src/main/java/org/opensearch/snapshots/AbortedSnapshotException.java +++ b/server/src/main/java/org/opensearch/snapshots/AbortedSnapshotException.java @@ -31,6 +31,11 @@ package org.opensearch.snapshots; +/** + * Exception thrown when there is an aborted snapshot + * + * @opensearch.internal + */ public final class AbortedSnapshotException extends RuntimeException { public AbortedSnapshotException() { super("aborted"); diff --git a/server/src/main/java/org/opensearch/snapshots/ConcurrentSnapshotExecutionException.java b/server/src/main/java/org/opensearch/snapshots/ConcurrentSnapshotExecutionException.java index 1bdf09c32eb..aa2c0ab42e4 100644 --- a/server/src/main/java/org/opensearch/snapshots/ConcurrentSnapshotExecutionException.java +++ b/server/src/main/java/org/opensearch/snapshots/ConcurrentSnapshotExecutionException.java @@ -39,6 +39,8 @@ import java.io.IOException; /** * Thrown when a user tries to multiple conflicting snapshot/restore operations at the same time. + * + * @opensearch.internal */ public class ConcurrentSnapshotExecutionException extends SnapshotException { diff --git a/server/src/main/java/org/opensearch/snapshots/EmptySnapshotsInfoService.java b/server/src/main/java/org/opensearch/snapshots/EmptySnapshotsInfoService.java index c29d39966dc..8629790bc9c 100644 --- a/server/src/main/java/org/opensearch/snapshots/EmptySnapshotsInfoService.java +++ b/server/src/main/java/org/opensearch/snapshots/EmptySnapshotsInfoService.java @@ -34,6 +34,11 @@ package org.opensearch.snapshots; import org.opensearch.common.collect.ImmutableOpenMap; +/** + * Service for getting information about empty snapshots + * + * @opensearch.internal + */ public class EmptySnapshotsInfoService implements SnapshotsInfoService { public static final EmptySnapshotsInfoService INSTANCE = new EmptySnapshotsInfoService(); diff --git a/server/src/main/java/org/opensearch/snapshots/InFlightShardSnapshotStates.java b/server/src/main/java/org/opensearch/snapshots/InFlightShardSnapshotStates.java index 469b5756228..17d77fcc069 100644 --- a/server/src/main/java/org/opensearch/snapshots/InFlightShardSnapshotStates.java +++ b/server/src/main/java/org/opensearch/snapshots/InFlightShardSnapshotStates.java @@ -53,6 +53,8 @@ import java.util.Set; * as well as the latest written shard generation per shard in case there is a shard generation for a shard that has * been cleanly written out to the repository but not yet made part of the current {@link org.opensearch.repositories.RepositoryData} * through a snapshot finalization. + * + * @opensearch.internal */ public final class InFlightShardSnapshotStates { diff --git a/server/src/main/java/org/opensearch/snapshots/InvalidSnapshotNameException.java b/server/src/main/java/org/opensearch/snapshots/InvalidSnapshotNameException.java index 8fe321a4fe7..5af529c7245 100644 --- a/server/src/main/java/org/opensearch/snapshots/InvalidSnapshotNameException.java +++ b/server/src/main/java/org/opensearch/snapshots/InvalidSnapshotNameException.java @@ -39,6 +39,8 @@ import java.io.IOException; /** * Thrown on the attempt to create a snapshot with invalid name + * + * @opensearch.internal */ public class InvalidSnapshotNameException extends SnapshotException { diff --git a/server/src/main/java/org/opensearch/snapshots/RestoreInfo.java b/server/src/main/java/org/opensearch/snapshots/RestoreInfo.java index fbcd54fd5d6..b8ee09ff53f 100644 --- a/server/src/main/java/org/opensearch/snapshots/RestoreInfo.java +++ b/server/src/main/java/org/opensearch/snapshots/RestoreInfo.java @@ -51,6 +51,8 @@ import java.util.Objects; * Information about successfully completed restore operation. *

* Returned as part of {@link org.opensearch.action.admin.cluster.snapshots.restore.RestoreSnapshotResponse} + * + * @opensearch.internal */ public class RestoreInfo implements ToXContentObject, Writeable { diff --git a/server/src/main/java/org/opensearch/snapshots/RestoreService.java b/server/src/main/java/org/opensearch/snapshots/RestoreService.java index 4e9f13408e5..a95c711870e 100644 --- a/server/src/main/java/org/opensearch/snapshots/RestoreService.java +++ b/server/src/main/java/org/opensearch/snapshots/RestoreService.java @@ -136,6 +136,8 @@ import static org.opensearch.snapshots.SnapshotUtils.filterIndices; * At the end of the successful restore process {@code RestoreService} calls {@link #cleanupRestoreState(ClusterChangedEvent)}, * which removes {@link RestoreInProgress} when all shards are completed. In case of * restore failure a normal recovery fail-over process kicks in. + * + * @opensearch.internal */ public class RestoreService implements ClusterStateApplier { diff --git a/server/src/main/java/org/opensearch/snapshots/Snapshot.java b/server/src/main/java/org/opensearch/snapshots/Snapshot.java index 0733ccd6be6..d084fad1c2b 100644 --- a/server/src/main/java/org/opensearch/snapshots/Snapshot.java +++ b/server/src/main/java/org/opensearch/snapshots/Snapshot.java @@ -41,6 +41,8 @@ import java.util.Objects; /** * Basic information about a snapshot - a SnapshotId and the repository that the snapshot belongs to. + * + * @opensearch.internal */ public final class Snapshot implements Writeable { diff --git a/server/src/main/java/org/opensearch/snapshots/SnapshotCreationException.java b/server/src/main/java/org/opensearch/snapshots/SnapshotCreationException.java index 6857b38aaec..184fcd5ceb9 100644 --- a/server/src/main/java/org/opensearch/snapshots/SnapshotCreationException.java +++ b/server/src/main/java/org/opensearch/snapshots/SnapshotCreationException.java @@ -38,6 +38,8 @@ import java.io.IOException; /** * Thrown when snapshot creation fails completely + * + * @opensearch.internal */ public class SnapshotCreationException extends SnapshotException { diff --git a/server/src/main/java/org/opensearch/snapshots/SnapshotException.java b/server/src/main/java/org/opensearch/snapshots/SnapshotException.java index 641addad169..9c78834907e 100644 --- a/server/src/main/java/org/opensearch/snapshots/SnapshotException.java +++ b/server/src/main/java/org/opensearch/snapshots/SnapshotException.java @@ -41,6 +41,8 @@ import java.io.IOException; /** * Generic snapshot exception + * + * @opensearch.internal */ public class SnapshotException extends OpenSearchException { diff --git a/server/src/main/java/org/opensearch/snapshots/SnapshotId.java b/server/src/main/java/org/opensearch/snapshots/SnapshotId.java index cbad6ddbb92..40efc505144 100644 --- a/server/src/main/java/org/opensearch/snapshots/SnapshotId.java +++ b/server/src/main/java/org/opensearch/snapshots/SnapshotId.java @@ -43,6 +43,8 @@ import java.util.Objects; /** * SnapshotId - snapshot name + snapshot UUID + * + * @opensearch.internal */ public final class SnapshotId implements Comparable, Writeable, ToXContentObject { diff --git a/server/src/main/java/org/opensearch/snapshots/SnapshotInProgressException.java b/server/src/main/java/org/opensearch/snapshots/SnapshotInProgressException.java index 4dc1c49ab3f..cd202ea7e5f 100644 --- a/server/src/main/java/org/opensearch/snapshots/SnapshotInProgressException.java +++ b/server/src/main/java/org/opensearch/snapshots/SnapshotInProgressException.java @@ -41,6 +41,8 @@ import java.io.IOException; /** * Thrown on the attempt to execute an action that requires * that no snapshot is in progress. + * + * @opensearch.internal */ public class SnapshotInProgressException extends OpenSearchException { diff --git a/server/src/main/java/org/opensearch/snapshots/SnapshotInfo.java b/server/src/main/java/org/opensearch/snapshots/SnapshotInfo.java index a7c96b88469..f08a52a4e75 100644 --- a/server/src/main/java/org/opensearch/snapshots/SnapshotInfo.java +++ b/server/src/main/java/org/opensearch/snapshots/SnapshotInfo.java @@ -64,6 +64,8 @@ import java.util.stream.Collectors; /** * Information about a snapshot + * + * @opensearch.internal */ public final class SnapshotInfo implements Comparable, ToXContent, Writeable { diff --git a/server/src/main/java/org/opensearch/snapshots/SnapshotMissingException.java b/server/src/main/java/org/opensearch/snapshots/SnapshotMissingException.java index ac8b733526b..2508ab89108 100644 --- a/server/src/main/java/org/opensearch/snapshots/SnapshotMissingException.java +++ b/server/src/main/java/org/opensearch/snapshots/SnapshotMissingException.java @@ -39,6 +39,8 @@ import java.io.IOException; /** * Thrown if requested snapshot doesn't exist + * + * @opensearch.internal */ public class SnapshotMissingException extends SnapshotException { diff --git a/server/src/main/java/org/opensearch/snapshots/SnapshotRestoreException.java b/server/src/main/java/org/opensearch/snapshots/SnapshotRestoreException.java index ff4d5fa53a8..8afd64571c0 100644 --- a/server/src/main/java/org/opensearch/snapshots/SnapshotRestoreException.java +++ b/server/src/main/java/org/opensearch/snapshots/SnapshotRestoreException.java @@ -38,6 +38,8 @@ import java.io.IOException; /** * Snapshot restore exception + * + * @opensearch.internal */ public class SnapshotRestoreException extends SnapshotException { public SnapshotRestoreException(final String repositoryName, final String snapshotName, final String message) { diff --git a/server/src/main/java/org/opensearch/snapshots/SnapshotShardFailure.java b/server/src/main/java/org/opensearch/snapshots/SnapshotShardFailure.java index e0318641003..5c94ab65b60 100644 --- a/server/src/main/java/org/opensearch/snapshots/SnapshotShardFailure.java +++ b/server/src/main/java/org/opensearch/snapshots/SnapshotShardFailure.java @@ -51,6 +51,8 @@ import java.util.Objects; /** * Stores information about failures that occurred during shard snapshotting process + * + * @opensearch.internal */ public class SnapshotShardFailure extends ShardOperationFailedException { diff --git a/server/src/main/java/org/opensearch/snapshots/SnapshotShardSizeInfo.java b/server/src/main/java/org/opensearch/snapshots/SnapshotShardSizeInfo.java index 9c8a8fb76fb..6c951078e59 100644 --- a/server/src/main/java/org/opensearch/snapshots/SnapshotShardSizeInfo.java +++ b/server/src/main/java/org/opensearch/snapshots/SnapshotShardSizeInfo.java @@ -36,6 +36,11 @@ import org.opensearch.cluster.routing.RecoverySource; import org.opensearch.cluster.routing.ShardRouting; import org.opensearch.common.collect.ImmutableOpenMap; +/** + * Information about a snapshot shard size + * + * @opensearch.internal + */ public class SnapshotShardSizeInfo { public static final SnapshotShardSizeInfo EMPTY = new SnapshotShardSizeInfo(ImmutableOpenMap.of()); diff --git a/server/src/main/java/org/opensearch/snapshots/SnapshotShardsService.java b/server/src/main/java/org/opensearch/snapshots/SnapshotShardsService.java index 80072807747..695426dea68 100644 --- a/server/src/main/java/org/opensearch/snapshots/SnapshotShardsService.java +++ b/server/src/main/java/org/opensearch/snapshots/SnapshotShardsService.java @@ -87,6 +87,8 @@ import static java.util.Collections.emptyMap; * This service runs on data nodes and controls currently running shard snapshots on these nodes. It is responsible for * starting and stopping shard level snapshots. * See package level documentation of {@link org.opensearch.snapshots} for details. + * + * @opensearch.internal */ public class SnapshotShardsService extends AbstractLifecycleComponent implements ClusterStateListener, IndexEventListener { private static final Logger logger = LogManager.getLogger(SnapshotShardsService.class); diff --git a/server/src/main/java/org/opensearch/snapshots/SnapshotState.java b/server/src/main/java/org/opensearch/snapshots/SnapshotState.java index 75718481edc..dd1b3ebb840 100644 --- a/server/src/main/java/org/opensearch/snapshots/SnapshotState.java +++ b/server/src/main/java/org/opensearch/snapshots/SnapshotState.java @@ -34,6 +34,8 @@ package org.opensearch.snapshots; /** * Represents the state that a snapshot can be in + * + * @opensearch.internal */ public enum SnapshotState { /** diff --git a/server/src/main/java/org/opensearch/snapshots/SnapshotUtils.java b/server/src/main/java/org/opensearch/snapshots/SnapshotUtils.java index 4515671a9fd..073e4f77230 100644 --- a/server/src/main/java/org/opensearch/snapshots/SnapshotUtils.java +++ b/server/src/main/java/org/opensearch/snapshots/SnapshotUtils.java @@ -45,6 +45,8 @@ import java.util.Set; /** * Snapshot utilities + * + * @opensearch.internal */ public class SnapshotUtils { diff --git a/server/src/main/java/org/opensearch/snapshots/SnapshotsInfoService.java b/server/src/main/java/org/opensearch/snapshots/SnapshotsInfoService.java index 376bd5e0574..5f16b6e20d3 100644 --- a/server/src/main/java/org/opensearch/snapshots/SnapshotsInfoService.java +++ b/server/src/main/java/org/opensearch/snapshots/SnapshotsInfoService.java @@ -32,6 +32,11 @@ package org.opensearch.snapshots; +/** + * Base interface for shard information + * + * @opensearch.internal + */ @FunctionalInterface public interface SnapshotsInfoService { SnapshotShardSizeInfo snapshotShardSizes(); diff --git a/server/src/main/java/org/opensearch/snapshots/SnapshotsService.java b/server/src/main/java/org/opensearch/snapshots/SnapshotsService.java index 746cccef8e5..106359c485f 100644 --- a/server/src/main/java/org/opensearch/snapshots/SnapshotsService.java +++ b/server/src/main/java/org/opensearch/snapshots/SnapshotsService.java @@ -137,6 +137,8 @@ import static org.opensearch.cluster.SnapshotsInProgress.completed; * Service responsible for creating snapshots. This service runs all the steps executed on the cluster-manager node during snapshot creation and * deletion. * See package level documentation of {@link org.opensearch.snapshots} for details. + * + * @opensearch.internal */ public class SnapshotsService extends AbstractLifecycleComponent implements ClusterStateApplier { diff --git a/server/src/main/java/org/opensearch/snapshots/UpdateIndexShardSnapshotStatusRequest.java b/server/src/main/java/org/opensearch/snapshots/UpdateIndexShardSnapshotStatusRequest.java index f4f629970cc..7eac9358257 100644 --- a/server/src/main/java/org/opensearch/snapshots/UpdateIndexShardSnapshotStatusRequest.java +++ b/server/src/main/java/org/opensearch/snapshots/UpdateIndexShardSnapshotStatusRequest.java @@ -44,6 +44,8 @@ import java.util.Objects; /** * Internal request that is used to send changes in snapshot status to master + * + * @opensearch.internal */ public class UpdateIndexShardSnapshotStatusRequest extends MasterNodeRequest { private final Snapshot snapshot; diff --git a/server/src/main/java/org/opensearch/snapshots/UpdateIndexShardSnapshotStatusResponse.java b/server/src/main/java/org/opensearch/snapshots/UpdateIndexShardSnapshotStatusResponse.java index 55b299c7832..d1df715ba62 100644 --- a/server/src/main/java/org/opensearch/snapshots/UpdateIndexShardSnapshotStatusResponse.java +++ b/server/src/main/java/org/opensearch/snapshots/UpdateIndexShardSnapshotStatusResponse.java @@ -36,6 +36,11 @@ import org.opensearch.common.io.stream.StreamOutput; import java.io.IOException; +/** + * Response sent when updating an index shard status + * + * @opensearch.internal + */ class UpdateIndexShardSnapshotStatusResponse extends ActionResponse { public static final UpdateIndexShardSnapshotStatusResponse INSTANCE = new UpdateIndexShardSnapshotStatusResponse(); diff --git a/server/src/main/java/org/opensearch/tasks/CancellableTask.java b/server/src/main/java/org/opensearch/tasks/CancellableTask.java index 1eef8bb47ab..439be2b630e 100644 --- a/server/src/main/java/org/opensearch/tasks/CancellableTask.java +++ b/server/src/main/java/org/opensearch/tasks/CancellableTask.java @@ -42,6 +42,8 @@ import static org.opensearch.search.SearchService.NO_TIMEOUT; /** * A task that can be canceled + * + * @opensearch.internal */ public abstract class CancellableTask extends Task { diff --git a/server/src/main/java/org/opensearch/tasks/LoggingTaskListener.java b/server/src/main/java/org/opensearch/tasks/LoggingTaskListener.java index 3a0c4eb560a..88eaae4a480 100644 --- a/server/src/main/java/org/opensearch/tasks/LoggingTaskListener.java +++ b/server/src/main/java/org/opensearch/tasks/LoggingTaskListener.java @@ -39,6 +39,8 @@ import org.apache.logging.log4j.message.ParameterizedMessage; /** * A TaskListener that just logs the response at the info level. Used when we * need a listener but aren't returning the result to the user. + * + * @opensearch.internal */ public final class LoggingTaskListener implements TaskListener { private static final Logger logger = LogManager.getLogger(LoggingTaskListener.class); diff --git a/server/src/main/java/org/opensearch/tasks/RawTaskStatus.java b/server/src/main/java/org/opensearch/tasks/RawTaskStatus.java index f9b4ce23f1a..6ec91b1741f 100644 --- a/server/src/main/java/org/opensearch/tasks/RawTaskStatus.java +++ b/server/src/main/java/org/opensearch/tasks/RawTaskStatus.java @@ -48,6 +48,8 @@ import static org.opensearch.common.xcontent.XContentHelper.convertToMap; /** * Raw, unparsed status from the task results index. + * + * @opensearch.internal */ public class RawTaskStatus implements Task.Status { public static final String NAME = "raw"; diff --git a/server/src/main/java/org/opensearch/tasks/ResourceStats.java b/server/src/main/java/org/opensearch/tasks/ResourceStats.java index aab103ad08d..31c129b7b2f 100644 --- a/server/src/main/java/org/opensearch/tasks/ResourceStats.java +++ b/server/src/main/java/org/opensearch/tasks/ResourceStats.java @@ -10,6 +10,8 @@ package org.opensearch.tasks; /** * Different resource stats are defined. + * + * @opensearch.internal */ public enum ResourceStats { CPU("cpu_time_in_nanos"), diff --git a/server/src/main/java/org/opensearch/tasks/ResourceStatsType.java b/server/src/main/java/org/opensearch/tasks/ResourceStatsType.java index c670ac5ba68..138c74e128d 100644 --- a/server/src/main/java/org/opensearch/tasks/ResourceStatsType.java +++ b/server/src/main/java/org/opensearch/tasks/ResourceStatsType.java @@ -8,7 +8,11 @@ package org.opensearch.tasks; -/** Defines the different types of resource stats. */ +/** + * Defines the different types of resource stats. + * + * @opensearch.internal + */ public enum ResourceStatsType { // resource stats of the worker thread reported directly from runnable. WORKER_STATS("worker_stats", false); diff --git a/server/src/main/java/org/opensearch/tasks/ResourceUsageInfo.java b/server/src/main/java/org/opensearch/tasks/ResourceUsageInfo.java index ae58f712b63..652562e3f9e 100644 --- a/server/src/main/java/org/opensearch/tasks/ResourceUsageInfo.java +++ b/server/src/main/java/org/opensearch/tasks/ResourceUsageInfo.java @@ -21,6 +21,8 @@ import java.util.concurrent.atomic.AtomicLong; *

* It captures the resource usage information like memory, CPU about a particular execution of thread * for a specific stats type. + * + * @opensearch.internal */ public class ResourceUsageInfo { private static final Logger logger = LogManager.getLogger(ResourceUsageInfo.class); diff --git a/server/src/main/java/org/opensearch/tasks/ResourceUsageMetric.java b/server/src/main/java/org/opensearch/tasks/ResourceUsageMetric.java index 0d13ffe6ec0..931e3aa00d7 100644 --- a/server/src/main/java/org/opensearch/tasks/ResourceUsageMetric.java +++ b/server/src/main/java/org/opensearch/tasks/ResourceUsageMetric.java @@ -8,6 +8,11 @@ package org.opensearch.tasks; +/** + * Information about resource usage + * + * @opensearch.internal + */ public class ResourceUsageMetric { private final ResourceStats stats; private final long value; diff --git a/server/src/main/java/org/opensearch/tasks/Task.java b/server/src/main/java/org/opensearch/tasks/Task.java index 62453d08724..522ecac5ef6 100644 --- a/server/src/main/java/org/opensearch/tasks/Task.java +++ b/server/src/main/java/org/opensearch/tasks/Task.java @@ -50,6 +50,8 @@ import java.util.concurrent.ConcurrentHashMap; /** * Current task information + * + * @opensearch.internal */ public class Task { diff --git a/server/src/main/java/org/opensearch/tasks/TaskAwareRequest.java b/server/src/main/java/org/opensearch/tasks/TaskAwareRequest.java index b10e85ae35d..baf2d1d94ea 100644 --- a/server/src/main/java/org/opensearch/tasks/TaskAwareRequest.java +++ b/server/src/main/java/org/opensearch/tasks/TaskAwareRequest.java @@ -36,6 +36,8 @@ import java.util.Map; /** * An interface for a request that can be used to register a task manager task + * + * @opensearch.internal */ public interface TaskAwareRequest { /** diff --git a/server/src/main/java/org/opensearch/tasks/TaskCancellationService.java b/server/src/main/java/org/opensearch/tasks/TaskCancellationService.java index aebd91b0041..4073a48bcde 100644 --- a/server/src/main/java/org/opensearch/tasks/TaskCancellationService.java +++ b/server/src/main/java/org/opensearch/tasks/TaskCancellationService.java @@ -57,6 +57,11 @@ import java.io.IOException; import java.util.Collection; import java.util.List; +/** + * Service used to cancel a task + * + * @opensearch.internal + */ public class TaskCancellationService { public static final String BAN_PARENT_ACTION_NAME = "internal:admin/tasks/ban"; private static final Logger logger = LogManager.getLogger(TaskCancellationService.class); diff --git a/server/src/main/java/org/opensearch/tasks/TaskCancelledException.java b/server/src/main/java/org/opensearch/tasks/TaskCancelledException.java index f9863a10639..5f43837c02e 100644 --- a/server/src/main/java/org/opensearch/tasks/TaskCancelledException.java +++ b/server/src/main/java/org/opensearch/tasks/TaskCancelledException.java @@ -38,6 +38,8 @@ import java.io.IOException; /** * A generic exception that can be thrown by a task when it's cancelled by the task manager API + * + * @opensearch.internal */ public class TaskCancelledException extends OpenSearchException { diff --git a/server/src/main/java/org/opensearch/tasks/TaskId.java b/server/src/main/java/org/opensearch/tasks/TaskId.java index e98df346b70..46fb491dcc1 100644 --- a/server/src/main/java/org/opensearch/tasks/TaskId.java +++ b/server/src/main/java/org/opensearch/tasks/TaskId.java @@ -44,6 +44,8 @@ import java.io.IOException; /** * Task id that consists of node id and id of the task on the node + * + * @opensearch.internal */ public final class TaskId implements Writeable { diff --git a/server/src/main/java/org/opensearch/tasks/TaskInfo.java b/server/src/main/java/org/opensearch/tasks/TaskInfo.java index b6814282b5d..fc6280cc643 100644 --- a/server/src/main/java/org/opensearch/tasks/TaskInfo.java +++ b/server/src/main/java/org/opensearch/tasks/TaskInfo.java @@ -62,6 +62,8 @@ import static org.opensearch.common.xcontent.ConstructingObjectParser.optionalCo * references as well as mutable state. That makes it impractical to send tasks over transport channels * and use in APIs. Instead, immutable and writeable TaskInfo objects are used to represent * snapshot information about currently running tasks. + * + * @opensearch.internal */ public final class TaskInfo implements Writeable, ToXContentFragment { private final TaskId taskId; diff --git a/server/src/main/java/org/opensearch/tasks/TaskListener.java b/server/src/main/java/org/opensearch/tasks/TaskListener.java index e5581ad08d2..97df8eacee5 100644 --- a/server/src/main/java/org/opensearch/tasks/TaskListener.java +++ b/server/src/main/java/org/opensearch/tasks/TaskListener.java @@ -34,6 +34,8 @@ package org.opensearch.tasks; /** * Listener for Task success or failure. + * + * @opensearch.internal */ public interface TaskListener { /** diff --git a/server/src/main/java/org/opensearch/tasks/TaskManager.java b/server/src/main/java/org/opensearch/tasks/TaskManager.java index 1f6169768f2..9bb931ea7f0 100644 --- a/server/src/main/java/org/opensearch/tasks/TaskManager.java +++ b/server/src/main/java/org/opensearch/tasks/TaskManager.java @@ -82,6 +82,8 @@ import static org.opensearch.http.HttpTransportSettings.SETTING_HTTP_MAX_HEADER_ /** * Task Manager service for keeping track of currently running tasks on the nodes + * + * @opensearch.internal */ public class TaskManager implements ClusterStateApplier { diff --git a/server/src/main/java/org/opensearch/tasks/TaskResourceStats.java b/server/src/main/java/org/opensearch/tasks/TaskResourceStats.java index c35e08ebb34..64fe4d73d49 100644 --- a/server/src/main/java/org/opensearch/tasks/TaskResourceStats.java +++ b/server/src/main/java/org/opensearch/tasks/TaskResourceStats.java @@ -26,6 +26,8 @@ import java.util.Objects; *

* Writeable TaskResourceStats objects are used to represent resource * snapshot information about currently running task. + * + * @opensearch.internal */ public class TaskResourceStats implements Writeable, ToXContentFragment { private final Map resourceUsage; diff --git a/server/src/main/java/org/opensearch/tasks/TaskResourceUsage.java b/server/src/main/java/org/opensearch/tasks/TaskResourceUsage.java index 6af3de2b78c..2786f7ca59c 100644 --- a/server/src/main/java/org/opensearch/tasks/TaskResourceUsage.java +++ b/server/src/main/java/org/opensearch/tasks/TaskResourceUsage.java @@ -28,6 +28,8 @@ import static org.opensearch.common.xcontent.ConstructingObjectParser.constructo *

* Writeable TaskResourceUsage objects are used to represent resource usage * information of running tasks. + * + * @opensearch.internal */ public class TaskResourceUsage implements Writeable, ToXContentFragment { private static final ParseField CPU_TIME_IN_NANOS = new ParseField("cpu_time_in_nanos"); diff --git a/server/src/main/java/org/opensearch/tasks/TaskResult.java b/server/src/main/java/org/opensearch/tasks/TaskResult.java index 8e10b2eaa1c..247cc645ef8 100644 --- a/server/src/main/java/org/opensearch/tasks/TaskResult.java +++ b/server/src/main/java/org/opensearch/tasks/TaskResult.java @@ -61,6 +61,8 @@ import static org.opensearch.common.xcontent.XContentHelper.convertToMap; /** * Information about a running task or a task that stored its result. Running tasks just have a {@link #getTask()} while * tasks with stored result will have either a {@link #getError()} or {@link #getResponse()}. + * + * @opensearch.internal */ public final class TaskResult implements Writeable, ToXContentObject { private final boolean completed; diff --git a/server/src/main/java/org/opensearch/tasks/TaskResultsService.java b/server/src/main/java/org/opensearch/tasks/TaskResultsService.java index e22793e057c..66d3aeb748c 100644 --- a/server/src/main/java/org/opensearch/tasks/TaskResultsService.java +++ b/server/src/main/java/org/opensearch/tasks/TaskResultsService.java @@ -73,6 +73,8 @@ import static org.opensearch.common.unit.TimeValue.timeValueMillis; /** * Service that can store task results. + * + * @opensearch.internal */ public class TaskResultsService { diff --git a/server/src/main/java/org/opensearch/tasks/ThreadResourceInfo.java b/server/src/main/java/org/opensearch/tasks/ThreadResourceInfo.java index 8b45c38c8fb..a0b38649b64 100644 --- a/server/src/main/java/org/opensearch/tasks/ThreadResourceInfo.java +++ b/server/src/main/java/org/opensearch/tasks/ThreadResourceInfo.java @@ -13,6 +13,8 @@ package org.opensearch.tasks; *

* It captures the resource usage information about a particular execution of thread * for a specific stats type like worker_stats or response_stats etc., + * + * @opensearch.internal */ public class ThreadResourceInfo { private volatile boolean isActive = true; diff --git a/server/src/main/java/org/opensearch/threadpool/ExecutorBuilder.java b/server/src/main/java/org/opensearch/threadpool/ExecutorBuilder.java index 5229afb0ec7..d26131484ba 100644 --- a/server/src/main/java/org/opensearch/threadpool/ExecutorBuilder.java +++ b/server/src/main/java/org/opensearch/threadpool/ExecutorBuilder.java @@ -44,7 +44,7 @@ import java.util.List; * * @param the underlying type of the executor settings * - * @opensearch.internal + * @opensearch.internal */ public abstract class ExecutorBuilder {