From e3edebe920f64074ac344de743fd05a6bf2bb3f3 Mon Sep 17 00:00:00 2001 From: Nick Knize Date: Fri, 13 May 2022 15:03:47 -0500 Subject: [PATCH] [Javadocs] add to o.o.rest, snapshots, and tasks packages (#3219) (#3311) Adds javadocs to org.opensearch.rest, snapshots, and tasks packages. Signed-off-by: Nicholas Walter Knize --- .../java/org/opensearch/rest/AbstractRestChannel.java | 5 +++++ .../main/java/org/opensearch/rest/BaseRestHandler.java | 2 ++ .../main/java/org/opensearch/rest/BytesRestResponse.java | 5 +++++ .../java/org/opensearch/rest/DeprecationRestHandler.java | 2 ++ .../src/main/java/org/opensearch/rest/MethodHandlers.java | 2 ++ server/src/main/java/org/opensearch/rest/RestChannel.java | 2 ++ .../src/main/java/org/opensearch/rest/RestController.java | 5 +++++ server/src/main/java/org/opensearch/rest/RestHandler.java | 2 ++ .../java/org/opensearch/rest/RestHeaderDefinition.java | 2 ++ server/src/main/java/org/opensearch/rest/RestRequest.java | 5 +++++ .../main/java/org/opensearch/rest/RestRequestFilter.java | 2 ++ .../src/main/java/org/opensearch/rest/RestResponse.java | 5 +++++ server/src/main/java/org/opensearch/rest/RestStatus.java | 5 +++++ server/src/main/java/org/opensearch/rest/RestUtils.java | 5 +++++ .../org/opensearch/rest/action/RestActionListener.java | 2 ++ .../main/java/org/opensearch/rest/action/RestActions.java | 5 +++++ .../org/opensearch/rest/action/RestBuilderListener.java | 2 ++ .../opensearch/rest/action/RestCancellableNodeClient.java | 2 ++ .../rest/action/RestFieldCapabilitiesAction.java | 5 +++++ .../java/org/opensearch/rest/action/RestMainAction.java | 5 +++++ .../org/opensearch/rest/action/RestResponseListener.java | 2 ++ .../rest/action/RestStatusToXContentListener.java | 2 ++ .../opensearch/rest/action/RestToXContentListener.java | 2 ++ .../admin/cluster/RestAddVotingConfigExclusionAction.java | 5 +++++ .../rest/action/admin/cluster/RestCancelTasksAction.java | 5 +++++ .../action/admin/cluster/RestCleanupRepositoryAction.java | 2 ++ .../cluster/RestClearVotingConfigExclusionsAction.java | 5 +++++ .../action/admin/cluster/RestCloneSnapshotAction.java | 2 ++ .../admin/cluster/RestClusterAllocationExplainAction.java | 2 ++ .../admin/cluster/RestClusterGetSettingsAction.java | 5 +++++ .../action/admin/cluster/RestClusterHealthAction.java | 5 +++++ .../action/admin/cluster/RestClusterRerouteAction.java | 5 +++++ .../admin/cluster/RestClusterSearchShardsAction.java | 5 +++++ .../rest/action/admin/cluster/RestClusterStateAction.java | 5 +++++ .../rest/action/admin/cluster/RestClusterStatsAction.java | 5 +++++ .../admin/cluster/RestClusterUpdateSettingsAction.java | 5 +++++ .../action/admin/cluster/RestCreateSnapshotAction.java | 2 ++ .../action/admin/cluster/RestDeleteRepositoryAction.java | 2 ++ .../action/admin/cluster/RestDeleteSnapshotAction.java | 2 ++ .../admin/cluster/RestDeleteStoredScriptAction.java | 5 +++++ .../action/admin/cluster/RestGetRepositoriesAction.java | 2 ++ .../action/admin/cluster/RestGetScriptContextAction.java | 5 +++++ .../action/admin/cluster/RestGetScriptLanguageAction.java | 5 +++++ .../rest/action/admin/cluster/RestGetSnapshotsAction.java | 2 ++ .../action/admin/cluster/RestGetStoredScriptAction.java | 5 +++++ .../rest/action/admin/cluster/RestGetTaskAction.java | 5 +++++ .../rest/action/admin/cluster/RestListTasksAction.java | 5 +++++ .../action/admin/cluster/RestNodesHotThreadsAction.java | 5 +++++ .../rest/action/admin/cluster/RestNodesInfoAction.java | 5 +++++ .../rest/action/admin/cluster/RestNodesStatsAction.java | 5 +++++ .../rest/action/admin/cluster/RestNodesUsageAction.java | 5 +++++ .../admin/cluster/RestPendingClusterTasksAction.java | 5 +++++ .../action/admin/cluster/RestPutRepositoryAction.java | 2 ++ .../action/admin/cluster/RestPutStoredScriptAction.java | 5 +++++ .../admin/cluster/RestReloadSecureSettingsAction.java | 5 +++++ .../action/admin/cluster/RestRemoteClusterInfoAction.java | 5 +++++ .../action/admin/cluster/RestRestoreSnapshotAction.java | 2 ++ .../action/admin/cluster/RestSnapshotsStatusAction.java | 2 ++ .../action/admin/cluster/RestVerifyRepositoryAction.java | 5 +++++ .../cluster/dangling/RestDeleteDanglingIndexAction.java | 5 +++++ .../cluster/dangling/RestImportDanglingIndexAction.java | 5 +++++ .../cluster/dangling/RestListDanglingIndicesAction.java | 5 +++++ .../action/admin/indices/AliasesNotFoundException.java | 5 +++++ .../action/admin/indices/RestAddIndexBlockAction.java | 5 +++++ .../rest/action/admin/indices/RestAnalyzeAction.java | 5 +++++ .../action/admin/indices/RestClearIndicesCacheAction.java | 5 +++++ .../rest/action/admin/indices/RestCloseIndexAction.java | 5 +++++ .../action/admin/indices/RestCreateDataStreamAction.java | 5 +++++ .../rest/action/admin/indices/RestCreateIndexAction.java | 5 +++++ .../action/admin/indices/RestDataStreamsStatsAction.java | 5 +++++ .../admin/indices/RestDeleteComponentTemplateAction.java | 5 +++++ .../indices/RestDeleteComposableIndexTemplateAction.java | 5 +++++ .../action/admin/indices/RestDeleteDataStreamAction.java | 5 +++++ .../rest/action/admin/indices/RestDeleteIndexAction.java | 5 +++++ .../admin/indices/RestDeleteIndexTemplateAction.java | 5 +++++ .../rest/action/admin/indices/RestFlushAction.java | 5 +++++ .../rest/action/admin/indices/RestForceMergeAction.java | 5 +++++ .../rest/action/admin/indices/RestGetAliasesAction.java | 2 ++ .../admin/indices/RestGetComponentTemplateAction.java | 5 +++++ .../indices/RestGetComposableIndexTemplateAction.java | 5 +++++ .../action/admin/indices/RestGetDataStreamsAction.java | 5 +++++ .../action/admin/indices/RestGetFieldMappingAction.java | 5 +++++ .../action/admin/indices/RestGetIndexTemplateAction.java | 2 ++ .../rest/action/admin/indices/RestGetIndicesAction.java | 2 ++ .../rest/action/admin/indices/RestGetMappingAction.java | 5 +++++ .../rest/action/admin/indices/RestGetSettingsAction.java | 5 +++++ .../admin/indices/RestIndexDeleteAliasesAction.java | 5 +++++ .../action/admin/indices/RestIndexPutAliasAction.java | 5 +++++ .../action/admin/indices/RestIndicesAliasesAction.java | 5 +++++ .../action/admin/indices/RestIndicesSegmentsAction.java | 5 +++++ .../admin/indices/RestIndicesShardStoresAction.java | 2 ++ .../rest/action/admin/indices/RestIndicesStatsAction.java | 5 +++++ .../rest/action/admin/indices/RestOpenIndexAction.java | 5 +++++ .../admin/indices/RestPutComponentTemplateAction.java | 5 +++++ .../indices/RestPutComposableIndexTemplateAction.java | 5 +++++ .../action/admin/indices/RestPutIndexTemplateAction.java | 5 +++++ .../rest/action/admin/indices/RestPutMappingAction.java | 5 +++++ .../rest/action/admin/indices/RestRecoveryAction.java | 2 ++ .../rest/action/admin/indices/RestRefreshAction.java | 5 +++++ .../rest/action/admin/indices/RestResizeHandler.java | 5 +++++ .../rest/action/admin/indices/RestResolveIndexAction.java | 5 +++++ .../action/admin/indices/RestRolloverIndexAction.java | 5 +++++ .../admin/indices/RestSimulateIndexTemplateAction.java | 5 +++++ .../action/admin/indices/RestSimulateTemplateAction.java | 5 +++++ .../rest/action/admin/indices/RestSyncedFlushAction.java | 8 ++++++++ .../action/admin/indices/RestUpdateSettingsAction.java | 5 +++++ .../rest/action/admin/indices/RestUpgradeAction.java | 5 +++++ .../action/admin/indices/RestUpgradeStatusAction.java | 5 +++++ .../action/admin/indices/RestValidateQueryAction.java | 5 +++++ .../org/opensearch/rest/action/cat/AbstractCatAction.java | 5 +++++ .../org/opensearch/rest/action/cat/RestAliasAction.java | 5 +++++ .../opensearch/rest/action/cat/RestAllocationAction.java | 5 +++++ .../org/opensearch/rest/action/cat/RestCatAction.java | 5 +++++ .../opensearch/rest/action/cat/RestCatRecoveryAction.java | 2 ++ .../org/opensearch/rest/action/cat/RestCountAction.java | 5 +++++ .../opensearch/rest/action/cat/RestFielddataAction.java | 2 ++ .../org/opensearch/rest/action/cat/RestHealthAction.java | 5 +++++ .../org/opensearch/rest/action/cat/RestIndicesAction.java | 5 +++++ .../org/opensearch/rest/action/cat/RestMasterAction.java | 5 +++++ .../opensearch/rest/action/cat/RestNodeAttrsAction.java | 5 +++++ .../org/opensearch/rest/action/cat/RestNodesAction.java | 5 +++++ .../rest/action/cat/RestPendingClusterTasksAction.java | 5 +++++ .../org/opensearch/rest/action/cat/RestPluginsAction.java | 5 +++++ .../rest/action/cat/RestRepositoriesAction.java | 2 ++ .../opensearch/rest/action/cat/RestSegmentsAction.java | 5 +++++ .../org/opensearch/rest/action/cat/RestShardsAction.java | 5 +++++ .../opensearch/rest/action/cat/RestSnapshotAction.java | 2 ++ .../java/org/opensearch/rest/action/cat/RestTable.java | 5 +++++ .../org/opensearch/rest/action/cat/RestTasksAction.java | 5 +++++ .../opensearch/rest/action/cat/RestTemplatesAction.java | 5 +++++ .../opensearch/rest/action/cat/RestThreadPoolAction.java | 5 +++++ .../opensearch/rest/action/document/RestBulkAction.java | 2 ++ .../opensearch/rest/action/document/RestDeleteAction.java | 5 +++++ .../opensearch/rest/action/document/RestGetAction.java | 5 +++++ .../rest/action/document/RestGetSourceAction.java | 2 ++ .../opensearch/rest/action/document/RestIndexAction.java | 5 +++++ .../rest/action/document/RestMultiGetAction.java | 5 +++++ .../rest/action/document/RestMultiTermVectorsAction.java | 5 +++++ .../rest/action/document/RestTermVectorsAction.java | 2 ++ .../opensearch/rest/action/document/RestUpdateAction.java | 5 +++++ .../rest/action/ingest/RestDeletePipelineAction.java | 5 +++++ .../rest/action/ingest/RestGetPipelineAction.java | 5 +++++ .../rest/action/ingest/RestPutPipelineAction.java | 5 +++++ .../rest/action/ingest/RestSimulatePipelineAction.java | 5 +++++ .../rest/action/search/RestClearScrollAction.java | 5 +++++ .../opensearch/rest/action/search/RestCountAction.java | 5 +++++ .../opensearch/rest/action/search/RestExplainAction.java | 2 ++ .../rest/action/search/RestMultiSearchAction.java | 5 +++++ .../opensearch/rest/action/search/RestSearchAction.java | 5 +++++ .../rest/action/search/RestSearchScrollAction.java | 5 +++++ .../java/org/opensearch/script/AbstractSortScript.java | 5 +++++ .../opensearch/snapshots/AbortedSnapshotException.java | 5 +++++ .../snapshots/ConcurrentSnapshotExecutionException.java | 2 ++ .../opensearch/snapshots/EmptySnapshotsInfoService.java | 5 +++++ .../opensearch/snapshots/InFlightShardSnapshotStates.java | 2 ++ .../snapshots/InvalidSnapshotNameException.java | 2 ++ .../main/java/org/opensearch/snapshots/RestoreInfo.java | 2 ++ .../java/org/opensearch/snapshots/RestoreService.java | 2 ++ .../src/main/java/org/opensearch/snapshots/Snapshot.java | 2 ++ .../opensearch/snapshots/SnapshotCreationException.java | 2 ++ .../java/org/opensearch/snapshots/SnapshotException.java | 2 ++ .../main/java/org/opensearch/snapshots/SnapshotId.java | 2 ++ .../opensearch/snapshots/SnapshotInProgressException.java | 2 ++ .../main/java/org/opensearch/snapshots/SnapshotInfo.java | 2 ++ .../opensearch/snapshots/SnapshotMissingException.java | 2 ++ .../opensearch/snapshots/SnapshotRestoreException.java | 2 ++ .../org/opensearch/snapshots/SnapshotShardFailure.java | 2 ++ .../org/opensearch/snapshots/SnapshotShardSizeInfo.java | 5 +++++ .../org/opensearch/snapshots/SnapshotShardsService.java | 2 ++ .../main/java/org/opensearch/snapshots/SnapshotState.java | 2 ++ .../main/java/org/opensearch/snapshots/SnapshotUtils.java | 2 ++ .../org/opensearch/snapshots/SnapshotsInfoService.java | 5 +++++ .../java/org/opensearch/snapshots/SnapshotsService.java | 2 ++ .../snapshots/UpdateIndexShardSnapshotStatusRequest.java | 2 ++ .../snapshots/UpdateIndexShardSnapshotStatusResponse.java | 5 +++++ .../main/java/org/opensearch/tasks/CancellableTask.java | 2 ++ .../java/org/opensearch/tasks/LoggingTaskListener.java | 2 ++ .../src/main/java/org/opensearch/tasks/RawTaskStatus.java | 2 ++ server/src/main/java/org/opensearch/tasks/Task.java | 2 ++ .../main/java/org/opensearch/tasks/TaskAwareRequest.java | 2 ++ .../org/opensearch/tasks/TaskCancellationService.java | 5 +++++ .../java/org/opensearch/tasks/TaskCancelledException.java | 2 ++ server/src/main/java/org/opensearch/tasks/TaskId.java | 2 ++ server/src/main/java/org/opensearch/tasks/TaskInfo.java | 2 ++ .../src/main/java/org/opensearch/tasks/TaskListener.java | 2 ++ .../src/main/java/org/opensearch/tasks/TaskManager.java | 2 ++ server/src/main/java/org/opensearch/tasks/TaskResult.java | 2 ++ .../java/org/opensearch/tasks/TaskResultsService.java | 2 ++ .../java/org/opensearch/threadpool/ExecutorBuilder.java | 2 +- 189 files changed, 740 insertions(+), 1 deletion(-) diff --git a/server/src/main/java/org/opensearch/rest/AbstractRestChannel.java b/server/src/main/java/org/opensearch/rest/AbstractRestChannel.java index 536972aa5a5d7..7b4fed30bcd8b 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 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 bf2fe0f16cb0d..9838c4072e02e 100644 --- a/server/src/main/java/org/opensearch/rest/BaseRestHandler.java +++ b/server/src/main/java/org/opensearch/rest/BaseRestHandler.java @@ -66,6 +66,8 @@ * 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 7d2b49f3f0171..68b3cc664fcb1 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_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 85a7f0f0281c5..e4e0acb2123eb 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 @@ /** * {@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 d8f5488dc2ee3..8c29bf2e66036 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 @@ /** * 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 e3108b6ca4b20..6d136a6cb6a7c 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 @@ /** * 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 f2030eb83a581..b576f8b83e5a0 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.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 9afa2d94b2044..14f54d371632d 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 @@ /** * 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 7e7b851a42d6e..9bea8055077fe 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 @@ /** * 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 7d11da7e122cd..65ba5b61eeddd 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 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 9b17dd4432552..e457ace80c8f7 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 @@ /** * 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 80d80cec3b30b..bbf6e5d34bd01 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.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 5f50559ef0f51..0b0fdeb22fa03 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 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 913910cead210..da2a14126d53c 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.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 d0e897ea811e0..d1c1c98b1b827 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 @@ /** * 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 7c5aaf4e763c3..59446eca33906 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 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 03e70388660de..07d1dcf180f0a 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 @@ /** * 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 046fb060733bf..ad84b6db0ed3e 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 @@ /** * 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 dea8e80687ed3..2c1087327776c 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 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 a3a37ba7699d8..7c4ca1aabbcea 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 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 63d5400041265..4dd1aa912dd40 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 @@ /** * 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 ade2ed6c3bd65..6416c61140c8f 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 @@ /** * 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 8ea55a4ccf493..cba79b0bc99d5 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 @@ /** * 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 c5f9d168a725c..f04985886084b 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 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 5415ad260b9e8..779d172b5d723 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 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 befd643167238..c2112aa28f7ce 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 @@ /** * 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 73a5a0c321b28..aa8a4879da5ca 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 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 4aa8bd44c3620..416528271b1b7 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 @@ /** * 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 b059e75870e87..a592b45eba805 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 @@ /** * 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 3917505c42496..a6d61c7771051 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 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 b00db3a7f6daf..29d26dd4e68fb 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 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 f375b572ef110..e1a4cab582f6b 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 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 20cd11e0308fe..e1b1389c47891 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 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 d97d1a0a30e28..9f5133b62e478 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.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 9bbabcdba146b..0766e838210fa 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.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 f42abcfbc6e29..01805ec85fce0 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 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 78c19732b5475..eb6694f63becd 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 @@ /** * 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 7c8a797b9c924..448f6ef85b085 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 @@ /** * 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 380a04dbcd387..4aff95eb600d8 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 @@ /** * 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 e1e705383e66b..652285f1f46b9 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 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 ddbad64cfd3dc..721f188da1077 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 @@ /** * 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 bc619b31a1d6a..5111397316b4c 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 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 4066781e8bb89..eacb9052ccab0 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 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 355071720c4ac..1932ae204624b 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 @@ /** * 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 43d386a4f3852..81cddb2cf01ca 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 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 39ed666e71696..963ab43acef48 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 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 058a822ab5f42..cb255b3dd2f2f 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 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 880791d2fb7e2..3c9321a8abaa4 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.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 dbb3ef68226f6..534ae087c0e9b 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.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 3c66b0740536f..c0e956fc419d3 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.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 f873a963ace30..bfa4181cb6e32 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.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 c6091adf9a57c..c8365ad4b8a2c 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 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 87aea07767b40..92dfa43a2cab6 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 @@ /** * 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 4b5979d566b8c..9f11494a174ad 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 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 2d5db335ef939..5d8312d9fa2b2 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.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 ea6b0cd79eac9..28edba4db387d 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 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 091e1abdbe2ab..ce942cf84b056 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 @@ /** * 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 78caad8f18522..e9a06647fbb19 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 @@ /** * 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 ee6d24119ca41..31e465d6002cf 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 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 40fbd028bde7a..eb57d0ca5b268 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 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 74c7340c2a7c5..222890f777573 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.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 13b13ac29ce01..c7c18fdf3f021 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 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 dc86cb360783c..595b6a4b2ed70 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 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 0df8721543a2c..b9b648e5bf3b4 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 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 f5b8ad7bb1864..f61cf8ddbbd59 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 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 603786c99a256..e4f0d7d006d87 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.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 98d75782bc741..f993f991e17a5 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.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 92662bb78e255..a65665b99138e 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.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 3c634106e68f1..247c8b5d591ad 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.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 2c7f27c5515a9..741be5c5ffc9c 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.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 4486b090ec333..ab61c1ab8487e 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 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 69db0b273ca73..6c02d6b112240 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 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 40e1add973b82..2665609511676 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.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 50673e12fa623..c671c01eac24d 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.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 d17214d41b75c..db99e32fcb70d 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 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 9fd88c0f4558d..03c91bced293f 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 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 6e2699228012e..e684cd27570b4 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.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 4ff519e81f9cd..e5a9897384041 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 @@ /** * 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 69e983d547a1f..43db1d1706aa1 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.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 8f3e58fd2298a..958b963ee59b6 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.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 539ad671e5fd3..3cf27e324a336 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 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 c35f417795377..dce688f32d0fd 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.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 617695f572817..486652086a865 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 @@ /** * 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 d2ae85c32a3ef..e16c4c3865859 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 @@ /** * 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 8d00528c9c60e..381561c12ce35 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 @@ -58,6 +58,11 @@ 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 final ThreadPool threadPool; 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 81d98b9bc9cc1..70b1cd80d499e 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.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 44422c910d367..5321cf7442c7e 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.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 f53a1c6d5b71a..8a70c739731dd 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 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 9524428f172ea..46b986d03e254 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 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 c635c8928bafd..3906c48295b4f 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.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 6030fad4e8501..7f6ba57f5d55d 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 @@ /** * 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 eabe14a7614ac..ba1407b36bfd9 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.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 4193a12807b32..4a1445ab7d9fe 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.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 f7b4200dc5307..95a5cb9da4d72 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 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 23a527a368d7d..397e67d285d63 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 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 ffd18356d0f5e..742161a4c1d06 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 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 9290e313fd939..fe489e4043815 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.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 75e3bcc97c68e..33c7b239e27ce 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 @@ /** * 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 28acfce57e3f3..2dc4c280956b5 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 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 3cdb63aa389be..b11535240b912 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 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 c4d96ca74492d..687ff554bd8d4 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 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 f57ec5d0e6606..b5d327ca5e2d7 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.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 064fb686a1f67..a3e7ea5175fa8 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 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 09ea8795b750f..812edaf542d4e 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 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 726fd69dc29c1..8d67aab6c474b 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 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 a616a86cee2bc..50c1c9f84b5a5 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 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 ba9dc76517852..1c925f030f582 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.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 d5582fa5c4414..a05b52b708770 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.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 bf300d5395b79..19bb559364385 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.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 d82a32cfc2c5d..abc08b9318ac1 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 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 78e0134fe0bda..7aa91c175dbf0 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.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 400fcb7cf0039..fc2837c068835 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.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 2aaccdbdf6bf5..b0fd6dd03fe4e 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 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 2dd7a2fddbf58..f18ace993599d 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 @@ * 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 033c9a278cabc..a35c0047a03bf 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.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 02de5f7301425..df70ee5943aad 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 @@ /** * 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 c05b0b9c77129..717df832d5d73 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 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 8d3a6e8b93916..200863219eb54 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 @@ -80,6 +80,11 @@ 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 6abadc00181b7..47571536cabda 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 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 b8291c43183f0..9f8ab747e7674 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 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 751ce9f8bb57a..5638eb4aed80d 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 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 27aa4c81d1dcc..9bcc5e357d383 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 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 f6a63baddbbe0..bcaab610f4aec 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 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 65c01ab16a99e..c41e84d7aaf06 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 @@ /** * 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 3adcce989ebe0..d07d895fd97eb 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.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 7ca8d053e19cf..7e6a157ca6885 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.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 c1a0b2773a7f5..134b4a4b6d96e 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 @@ /** * 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 69977cb73645a..7b1e967230780 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.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 b87205593ce87..779f5dc9eafc8 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 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 b18f81a939682..9cbec0314d3e0 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.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 dbfe12288940d..57dfca147f393 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.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 c140514e3c92c..3fc02db0a8365 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 @@ * { "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 f9f5933a44c95..6b882369a883a 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.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 a0ec48ee55451..87bec22ac2d73 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.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 801ab85039d2d..ecd97ceada0fc 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 @@ /** * 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 75f3967c32ba7..ba3558f6fe80c 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 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 6713bddfd837d..e676cdf6f1beb 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 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 66b0c004b9fb4..c453094f33120 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 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 727b90474082e..e2b14629e75f4 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 @@ /** * 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 832d8da4a8fdd..b3683e7b49fd7 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.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 2e7c99fc89f5f..6a876e7c22d61 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 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 e652f45b95180..2463cc8e153c8 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.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 d044f3cfd6e58..5a2a320d2e6ab 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 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 1f8d9edce6eab..eb193edda3373 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 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 6bdbb47033859..b9f57feab4296 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.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 6cb00633de441..a4a8b2c3b5e56 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.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 2b73e145cf5ca..bf29e0edfd2ab 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 @@ /** * 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 8262f8199a704..c5af10e5ce681 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 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 b84200407462f..2db131723bc57 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.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 bb725c35e8799..28dc5f64763c2 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.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 d1a1b321b0ace..c72717f8bc927 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.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 6aa75ee49bd1e..930d9408552bc 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 1bdf09c32ebd2..aa2c0ab42e42e 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 @@ /** * 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 c29d39966dc9c..8629790bc9cbb 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 @@ 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 469b57562284f..17d77fcc0695b 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 @@ * 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 8fe321a4fe74b..5af529c72458c 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 @@ /** * 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 fbcd54fd5d6d1..b8ee09ff53fea 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 @@ * 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 0869858900382..66a33cd5052ab 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 @@ * 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 0733ccd6be6f1..d084fad1c2b21 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 @@ /** * 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 6857b38aaecba..184fcd5ceb9f8 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 @@ /** * 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 641addad169bb..9c78834907e85 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 @@ /** * 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 cbad6ddbb92a6..40efc5051449b 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 @@ /** * 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 4dc1c49ab3fcc..cd202ea7e5f98 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 @@ /** * 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 25d27037e79d0..d7ebba721a52c 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 @@ /** * 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 ac8b733526b7c..2508ab89108eb 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 @@ /** * 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 ff4d5fa53a857..8afd64571c0ac 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 @@ /** * 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 e0318641003f8..5c94ab65b60c3 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 @@ /** * 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 9c8a8fb76fb23..6c951078e59e6 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.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 450ee06e9d5cf..e21a0b251dedc 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 @@ * 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 75718481edce6..dd1b3ebb8404d 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 @@ /** * 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 4515671a9fd10..073e4f7723077 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 @@ /** * 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 376bd5e05742f..5f16b6e20d3af 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 3a736fbb63849..9a794d6d9db08 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 @@ * Service responsible for creating snapshots. This service runs all the steps executed on the master 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 f4f629970ccfa..7eac935825783 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 @@ /** * 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 55b299c7832c8..d1df715ba629a 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 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 1eef8bb47abef..439be2b630e84 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 @@ /** * 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 3a0c4eb560afc..88eaae4a480f8 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 @@ /** * 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 f9b4ce23f1ae1..6ec91b1741f37 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 @@ /** * 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/Task.java b/server/src/main/java/org/opensearch/tasks/Task.java index ad9d5c3f04411..818b616c5b2b8 100644 --- a/server/src/main/java/org/opensearch/tasks/Task.java +++ b/server/src/main/java/org/opensearch/tasks/Task.java @@ -43,6 +43,8 @@ /** * 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 b10e85ae35dc6..baf2d1d94ea04 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 @@ /** * 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 aebd91b0041ac..4073a48bcde0d 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.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 f9863a10639e0..5f43837c02e7f 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 @@ /** * 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 e98df346b7041..46fb491dcc15f 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 @@ /** * 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 cf77eaf540ee6..6c6593fad54e9 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 @@ * 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 e5581ad08d226..97df8eacee584 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 @@ /** * 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 1f6169768f245..9bb931ea7f0aa 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 @@ /** * 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/TaskResult.java b/server/src/main/java/org/opensearch/tasks/TaskResult.java index 8e10b2eaa1cdf..247cc645ef8a3 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 @@ /** * 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 e22793e057c6a..66d3aeb748cf7 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 @@ /** * Service that can store task results. + * + * @opensearch.internal */ public class TaskResultsService { diff --git a/server/src/main/java/org/opensearch/threadpool/ExecutorBuilder.java b/server/src/main/java/org/opensearch/threadpool/ExecutorBuilder.java index 5229afb0ec71c..d26131484ba71 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 @@ * * @param the underlying type of the executor settings * - * @opensearch.internal + * @opensearch.internal */ public abstract class ExecutorBuilder {