[Refactor] Base Action class javadocs to OpenSearch.API (opensearch-p…

…roject#4732) Refactors base action classes implemented by external plugins through ActionPlugin from opensearch.internal to opensearch.api to signal extensibility to third-party developers. Signed-off-by: Nicholas Walter Knize <nknize@apache.org>
ashking94 · Nov 7, 2022 · c3cd637 · c3cd637
1 parent 74a9678
commit c3cd637
Show file tree

Hide file tree

Showing 10 changed files with 14 additions and 13 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -79,6 +79,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Update to Apache Lucene 9.4.0 ([#4661](https://github.com/opensearch-project/OpenSearch/pull/4661))
 - Controlling discovery for decommissioned nodes ([#4590](https://github.com/opensearch-project/OpenSearch/pull/4590))
 - Backport Apache Lucene version change for 2.4.0 ([#4677](https://github.com/opensearch-project/OpenSearch/pull/4677))
+- Refactor Base Action class javadocs to OpenSearch.API ([#4732](https://github.com/opensearch-project/OpenSearch/pull/4732))
 
 ### Deprecated
 
@@ -163,4 +164,4 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 ### Security
 
 [Unreleased]: https://github.com/opensearch-project/OpenSearch/compare/2.2.0...HEAD
-[2.x]: https://github.com/opensearch-project/OpenSearch/compare/2.2.0...2.x
+[2.x]: https://github.com/opensearch-project/OpenSearch/compare/2.2.0...2.x
diff --git a/server/src/main/java/org/opensearch/action/ActionFuture.java b/server/src/main/java/org/opensearch/action/ActionFuture.java
@@ -40,7 +40,7 @@
 /**
  * An extension to {@link Future} allowing for simplified "get" operations.
  *
- * @opensearch.internal
+ * @opensearch.api
  */
 public interface ActionFuture<T> extends Future<T> {
 

diff --git a/server/src/main/java/org/opensearch/action/ActionListener.java b/server/src/main/java/org/opensearch/action/ActionListener.java
@@ -46,7 +46,7 @@
 /**
  * A listener for action responses or failures.
  *
- * @opensearch.internal
+ * @opensearch.api
  */
 public interface ActionListener<Response> {
     /**

diff --git a/server/src/main/java/org/opensearch/action/ActionListenerResponseHandler.java b/server/src/main/java/org/opensearch/action/ActionListenerResponseHandler.java
@@ -46,7 +46,7 @@
  * A simple base class for action response listeners, defaulting to using the SAME executor (as its
  * very common on response handlers).
  *
- * @opensearch.internal
+ * @opensearch.api
  */
 public class ActionListenerResponseHandler<Response extends TransportResponse> implements TransportResponseHandler<Response> {
 

diff --git a/server/src/main/java/org/opensearch/action/ActionRequest.java b/server/src/main/java/org/opensearch/action/ActionRequest.java
@@ -39,9 +39,9 @@
 import java.io.IOException;
 
 /**
- * Base action request
+ * Base action request implemented by plugins.
  *
- * @opensearch.internal
+ * @opensearch.api
  */
 public abstract class ActionRequest extends TransportRequest {
 

diff --git a/server/src/main/java/org/opensearch/action/ActionRequestBuilder.java b/server/src/main/java/org/opensearch/action/ActionRequestBuilder.java
@@ -40,7 +40,7 @@
 /**
  * Base Action Request Builder
  *
- * @opensearch.internal
+ * @opensearch.api
  */
 public abstract class ActionRequestBuilder<Request extends ActionRequest, Response extends ActionResponse> {
 

diff --git a/server/src/main/java/org/opensearch/action/ActionRequestValidationException.java b/server/src/main/java/org/opensearch/action/ActionRequestValidationException.java
@@ -35,8 +35,8 @@
 import org.opensearch.common.ValidationException;
 
 /**
- * Base exception for an action request validation
+ * Base exception for an action request validation extendable by plugins
  *
- * @opensearch.internal
+ * @opensearch.api
  */
 public class ActionRequestValidationException extends ValidationException {}
diff --git a/server/src/main/java/org/opensearch/action/ActionResponse.java b/server/src/main/java/org/opensearch/action/ActionResponse.java
@@ -38,9 +38,9 @@
 import java.io.IOException;
 
 /**
- * Base class for responses to action requests.
+ * Base class for responses to action requests implemented by plugins.
  *
- * @opensearch.internal
+ * @opensearch.api
  */
 public abstract class ActionResponse extends TransportResponse {
 

diff --git a/server/src/main/java/org/opensearch/action/ActionRunnable.java b/server/src/main/java/org/opensearch/action/ActionRunnable.java
@@ -41,7 +41,7 @@
  * Base class for {@link Runnable}s that need to call {@link ActionListener#onFailure(Exception)} in case an uncaught
  * exception or error is thrown while the actual action is run.
  *
- * @opensearch.internal
+ * @opensearch.api
  */
 public abstract class ActionRunnable<Response> extends AbstractRunnable {
 

diff --git a/server/src/main/java/org/opensearch/action/ActionType.java b/server/src/main/java/org/opensearch/action/ActionType.java
@@ -39,7 +39,7 @@
 /**
  * A generic action. Should strive to make it a singleton.
  *
- * @opensearch.internal
+ * @opensearch.api
  */
 public class ActionType<Response extends ActionResponse> {