OpenSearch/docs/reference/cluster
Nik Everett 09aaed4fe4
Tasks: Document that status is not semvered (#34270)
The `status` part of the tasks API reflects the internal status of a
running task. In general, we do not make backwards breaking changes to
the `status` but because it is internal we reserve the right to do so. I
suspect we will very rarely excercise that right but it is important
that we have it so we're not boxed into any particular implementation
for a request.

In some sense this is policy making by documentation change. In another
it is clarification of the way we've always thought of this field.

I also reflect the documentation change into the Javadoc in a few
places. There I acknowledge Kibana's "special relationship" with
Elasticsearch. Kibana parses `_reindex`'s `status` field and, because
we're friends with those folks, we should talk to them before we make
backwards breaking changes to it. We *want* to be friends with everyone
but there is only so much time in the day and we don't *want* to make
backwards breaking fields to `status` at all anyway. So we hope that
breaking changes documentation should be enough for other folks.

Relates to #34245.
2018-10-04 14:42:37 -04:00
..
allocation-explain.asciidoc [Docs] Convert remaining code snippets in docs (#26422) 2017-08-30 12:11:10 +02:00
get-settings.asciidoc rest-high-level: added get cluster settings (#31706) 2018-07-02 13:25:17 -04:00
health.asciidoc REST high-level client: add Cluster Health API (#29331) 2018-06-12 13:34:06 +02:00
nodes-hot-threads.asciidoc Update docs for node specifications (#30468) 2018-08-20 14:21:31 +01:00
nodes-info.asciidoc Docs: Use the default distribution to test docs (#31251) 2018-06-18 12:06:42 -04:00
nodes-reload-secure-settings.asciidoc Reload Secure Settings REST specs & docs (#32990) 2018-08-26 14:49:32 +03:00
nodes-stats.asciidoc Deprecate the suggest metrics (#29627) 2018-04-20 09:47:38 -04:00
nodes-usage.asciidoc Fix cluster usage docs test 2017-12-01 16:55:10 +01:00
pending.asciidoc [Docs] Convert more doc snippets (#26404) 2017-08-30 09:30:36 +02:00
remote-info.asciidoc [Docs] Remove repeating words (#33087) 2018-08-28 13:16:43 +02:00
reroute.asciidoc [Docs] Remove repeating words (#33087) 2018-08-28 13:16:43 +02:00
state.asciidoc _cluster/state should always return cluster_uuid (#30143) 2018-04-30 10:16:11 -04:00
stats.asciidoc Update docs for node specifications (#30468) 2018-08-20 14:21:31 +01:00
tasks.asciidoc Tasks: Document that status is not semvered (#34270) 2018-10-04 14:42:37 -04:00
update-settings.asciidoc [Docs] Add reason to use Settings API over config file (#32405) 2018-09-26 11:59:36 +02:00