Note that GET /_cluster/state is unstable #40104
Merged
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 `GET /_cluster/state` API returns an internal representation of the cluster state that does change from version to version. It's useful for debugging, but it is not intended for regular use by clients. This change adjusts the documentation of `GET /_cluster/state` to clarify that this API yields an internal representation that should not be expected to remain stable between versions. Relates elastic#40061, elastic#40016
DaveCTurner
added
>docs
|
Pinging @elastic/es-distributed |
DaveCTurner
added a commit
that referenced
this pull request
Mar 18, 2019
The `GET /_cluster/state` API returns an internal representation of the cluster state that does change from version to version. It's useful for debugging, but it is not intended for regular use by clients. This change adjusts the documentation of `GET /_cluster/state` to clarify that this API yields an internal representation that should not be expected to remain stable between versions. Relates #40061, #40016
DaveCTurner
added a commit
that referenced
this pull request
Mar 18, 2019
The `GET /_cluster/state` API returns an internal representation of the cluster state that does change from version to version. It's useful for debugging, but it is not intended for regular use by clients. This change adjusts the documentation of `GET /_cluster/state` to clarify that this API yields an internal representation that should not be expected to remain stable between versions. Relates #40061, #40016
DaveCTurner
added a commit
that referenced
this pull request
Mar 18, 2019
The `GET /_cluster/state` API returns an internal representation of the cluster state that does change from version to version. It's useful for debugging, but it is not intended for regular use by clients. This change adjusts the documentation of `GET /_cluster/state` to clarify that this API yields an internal representation that should not be expected to remain stable between versions. Relates #40061, #40016
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
GET /_cluster/stateAPI returns an internal representation of the clusterstate that does change from version to version. It's useful for debugging, but
it is not intended for regular use by clients.
This change adjusts the documentation of
GET /_cluster/stateto clarify thatthis API yields an internal representation that should not be expected to
remain stable between versions.
Relates #40061, #40016