Improve dev docs for ActionType
#104139
Merged
Improve dev docs for ActionType
#104139
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The semantics of `ActionType` are somewhat confusing; this commit expands its Javadocs a bit to try and clarify how to use it.
DaveCTurner
added
>non-issue
:Core/Infra/Transport API
|
Pinging @elastic/es-core-infra (Team:Core/Infra) |
joegallo
reviewed
Jan 9, 2024
| * | ||
| * @param name The name of the action, which must be unique across actions. When executed on a remote cluster, this is the | ||
| * ID of the transport action which is sent to the handling node in the remote cluster. | ||
| * @param responseReader A reader for the response type, which is only used by actions executed on a remote cluster. |
There was a problem hiding this comment.
A reader for the response type, which is only used by actions executed on a remote cluster.
Is that a reader for the response from the action executed on the remote cluster? I'm trying to read the as-written words incorrectly and I feel like I can convince myself that those words say that it's the action executed on the remote cluster that uses the reader.
There was a problem hiding this comment.
Fair, I see the ambiguity. Let me rearrange the words, sec.
There was a problem hiding this comment.
1b8526b any better?
There was a problem hiding this comment.
SO MUCH BETTER. Thank you! I love it!
DaveCTurner
added
the
auto-merge-without-approval
ldematte
approved these changes
Jan 10, 2024
DaveCTurner
added a commit
to DaveCTurner/elasticsearch
that referenced
this pull request
Jan 26, 2024
Aligns the actions in the enterprise search module with the docs added in elastic#104139.
DaveCTurner
added a commit
that referenced
this pull request
Jan 29, 2024
Aligns the actions in the enterprise search module with the docs added in #104139.
DaveCTurner
added a commit
to DaveCTurner/elasticsearch
that referenced
this pull request
Oct 20, 2025
No need for these things to be subclasses of `ActionType`, let's save some metaspace. Relates elastic#104139
DaveCTurner
added a commit
that referenced
this pull request
Oct 20, 2025
No need for these things to be subclasses of `ActionType`, let's save some metaspace. Relates #104139
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The semantics of
ActionTypeare somewhat confusing; this commitexpands its Javadocs a bit to try and clarify how to use it.