Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Refactor] Base Action class javadocs to OpenSearch.API #4732

Merged
merged 2 commits into from
Oct 11, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Original file line number Diff line number Diff line change
Expand Up @@ -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> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
/**
* A listener for action responses or failures.
*
* @opensearch.internal
* @opensearch.api
*/
public interface ActionListener<Response> {
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
/**
* Base Action Request Builder
*
* @opensearch.internal
* @opensearch.api
*/
public abstract class ActionRequestBuilder<Request extends ActionRequest, Response extends ActionResponse> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 {}
Original file line number Diff line number Diff line change
Expand Up @@ -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 {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
/**
* A generic action. Should strive to make it a singleton.
*
* @opensearch.internal
* @opensearch.api
*/
public class ActionType<Response extends ActionResponse> {

Expand Down