[8.x] [DOCS] Clarify remote/info and resolve/cluster descriptions (#3655) #3667
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
Relates to elastic/elasticsearch#118993 This PR updates the remote info and resolve cluster specifications to (1) copy some missing descriptions from the docs (https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-remote-info.html and https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-resolve-cluster-api.html) and (2) incorporate the changes from elastic/elasticsearch#118993 Co-authored by @lcawl (cherry picked from commit 5b17efd)
|
Following you can find the validation results for the APIs you have changed.
You can validate these APIs yourself by using the |
quux00
reviewed
Jan 30, 2025
| num_proxy_sockets_connected: integer | ||
| /** The maximum number of socket connections to the remote cluster when proxy mode is configured. */ | ||
| max_proxy_socket_connections: integer | ||
| /** This field presents and has value of ::es_redacted:: only when the remote cluster is configured with the API key based model. Otherwise, the field is not present. */ |
There was a problem hiding this comment.
Hmm, I thought I fixed this to say "This field is present"? Sorry that fix that lost somehow.
quux00
approved these changes
Jan 30, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Backport
This will backport the following commits from
mainto8.x:Questions ?
Please refer to the Backport tool documentation