Skip to content

Commit

Permalink
Add admonition to cluster state instability note (#57985)
Browse files Browse the repository at this point in the history 
We document that the cluster state API is an internal representation which may
change, but apparently not emphatically enough. This commit adds a `NOTE:`
admonition to this paragraph.
  • Loading branch information
@DaveCTurner
DaveCTurner committed Jun 11, 2020
1 parent 06056fc commit 0206162
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/reference/cluster/state.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ whole cluster. This includes information such as

* the locations of all the shards in the cluster.

The response is an internal representation of the cluster state and its format
may change from version to version. If possible, you should obtain any
NOTE: The response is an internal representation of the cluster state and its
format may change from version to version. If possible, you should obtain any
information from the cluster state using the other, more stable,
<<cluster,cluster APIs>>.

Expand Down

0 comments on commit 0206162

Please sign in to comment.