Skip to content

Commit

Permalink
Add deprecation docs for cluster health HTTP code (#79451)
Browse files Browse the repository at this point in the history
Documents the deprecation introduced in #78180 and adjusted in #79351.
  • Loading branch information
DaveCTurner authored Oct 19, 2021
1 parent 28eb464 commit 9184b4c
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions docs/reference/migration/migrate_7_16.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -267,4 +267,30 @@ To avoid deprecation warnings, discontinue use of transient settings when modify
your cluster settings through the `PUT _cluster/settings` REST API. When modifying cluster settings
use only persistent settings.
====

[discrete]
[[breaking_716_cluster_deprecations]]
==== Cluster deprecations

[[deprecate-cluster-health-408]]
.Distinguishing cluster health timeout status by HTTP response code is now deprecated.
[%collapsible]
====
*Details* +
The <<cluster-health>> API includes options for waiting for certain health
conditions to be satisfied. If the requested conditions are not satisfied
within a timeout then {es} will send back a normal response including the field
`"timed_out": true`. In earlier versions it would also use the HTTP response
code `408 Request timeout` if the request timed out, and `200 OK` otherwise.
The `408 Request timeout` response code is not appropriate for this situation
and its use is deprecated. Future versions will use the response code `200 OK`
for both cases.
*Impact* +
Update your application to read the `"timed_out"` field of the response instead
of the HTTP response code to determine whether the request timed out or not. To
avoid deprecation warnings and opt into the future behaviour, include the query
parameter `?return_200_for_cluster_health_timeout` in your request.
====

// end::notable-breaking-changes[]

0 comments on commit 9184b4c

Please sign in to comment.