honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/reference
History
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
..
aggregations Docs: Allow skipping response assertions (#34240) 2018-10-04 08:03:38 -04:00
analysis [DOCS] Clarify 'type' parameter meaning for custom analyzer (#34012) 2018-09-25 15:32:27 +02:00
cat Remove discovery-file plugin (#33257) 2018-09-18 12:01:16 +01:00
cluster Tasks: Document that status is not semvered (#34270) 2018-10-04 14:42:37 -04:00
commands Fix a variety of typos and misspelled words (#32792) 2018-10-03 18:11:38 +01:00
docs [DOCS] Clarifies examples in reindex and task APIs (#33143) 2018-10-02 08:37:45 -07:00
graph [DOCS] Moves graph to docs folder (#33472) 2018-09-26 14:59:31 -07:00
how-to Docs: Corrected typo in how to (#33910) 2018-09-20 16:13:46 -04:00
images DOC: Add SQL section on client applications 2018-09-13 15:44:52 +03:00
index-modules drop elasticsearch-translog for 7.0 (#33373) 2018-10-01 16:21:14 +02:00
indices Merge branch 'master' into ccr 2018-07-31 10:56:10 -04:00
ingest ingest: Introduce the dissect processor (#32884) 2018-08-28 07:11:20 -07:00
licensing [DOCS] Fix licensing API details (#31667) 2018-06-28 15:38:41 -07:00
mapping Remove leftover doc about format being updatable 2018-09-25 10:13:23 +02:00
migration Add migration info for missing values in script 2018-10-03 11:56:18 -04:00
ml [ML] Label anomalies with multi_bucket_impact (#34233) 2018-10-04 09:08:21 +01:00
modules [DOCS] Note that User Cluster Metadata is not private (#34156) 2018-10-02 13:36:13 -06:00
monitoring Implement xpack.monitoring.elasticsearch.collection.enabled setting (#33474) 2018-09-17 18:33:43 -07:00
query-dsl Add a deprecation warning in the type query documentation. (#34017) 2018-09-24 16:30:38 -07:00
release-notes [DOCS] Synchronizes captialization in top-level titles (#33605) 2018-09-27 08:36:18 -07:00
rest-api [DOCS] Moves graph to docs folder (#33472) 2018-09-26 14:59:31 -07:00
rollup Fix a variety of typos and misspelled words (#32792) 2018-10-03 18:11:38 +01:00
search [DOCS] Update scroll.asciidoc (#32530) 2018-09-18 17:00:22 +02:00
security [DOCS] Moves security reference to docs folder (#33643) 2018-09-14 13:09:47 -07:00
settings Document smtp.ssl.trust configuration option (#34275) 2018-10-04 10:53:55 +03:00
setup Core: Default node.name to the hostname (#33677) 2018-09-19 15:21:29 -04:00
sql Fix a variety of typos and misspelled words (#32792) 2018-10-03 18:11:38 +01:00
testing [Docs] Remove repeating words (#33087) 2018-08-28 13:16:43 +02:00
upgrade [Test] Remove duplicate method in TestShardRouting (#32815) 2018-09-10 18:29:00 +02:00
aggregations.asciidoc [Docs] Update aggregations.asciidoc (#29265) 2018-03-28 15:01:45 +02:00
analysis.asciidoc [Docs] Add clarification to analysis example (#31826) 2018-07-06 14:36:58 +02:00
api-conventions.asciidoc [DOCS] Synchronizes captialization in top-level titles (#33605) 2018-09-27 08:36:18 -07:00
cat.asciidoc Rename the bulk thread pool to write thread pool (#29593) 2018-04-19 08:18:58 -04:00
cluster.asciidoc Update docs for node specifications (#30468) 2018-08-20 14:21:31 +01:00
docs.asciidoc Inclusion of link to Multi Delete (#22619) 2017-01-16 12:58:59 +01:00
getting-started.asciidoc Change "REST Verb" to "HTTP Verb" (#34195) 2018-10-02 17:09:54 -04:00
glossary.asciidoc Default to one shard (#30539) 2018-05-14 12:22:35 -04:00
gs-index.asciidoc [DOCS] Adding index file for GS "mini book". 2017-07-18 13:44:08 -07:00
how-to.asciidoc Correct grammar in list in how-to docs 2017-01-17 20:57:22 -05:00
index-modules.asciidoc [DOCS] Synchronizes captialization in top-level titles (#33605) 2018-09-27 08:36:18 -07:00
index.asciidoc [DOCS] Synchronize location of Breaking Changes (#33588) 2018-09-27 08:41:38 -07:00
index.x.asciidoc [DOCS] Removes redundant index.asciidoc files (#30707) 2018-05-18 11:05:40 -07:00
indices.asciidoc add split index reference in indices.asciidoc 2017-11-06 12:55:41 +01:00
ingest.asciidoc [DOCS] Synchronizes captialization in top-level titles (#33605) 2018-09-27 08:36:18 -07:00
mapping.asciidoc Don't count metadata fields towards index.mapping.total_fields.limit (#33386) 2018-09-05 18:27:21 +02:00
modules.asciidoc Remove left-over tribe reference 2018-01-30 21:44:21 +01:00
query-dsl.asciidoc Update query-dsl.asciidoc (#27669) 2017-12-11 18:06:08 +01:00
redirects.asciidoc Upgrade to a Lucene 8 snapshot (#33310) 2018-09-06 14:42:06 +02:00
release-notes.asciidoc [DOCS] Synchronizes captialization in top-level titles (#33605) 2018-09-27 08:36:18 -07:00
search.asciidoc [Docs] Add search timeout caveats (#33354) 2018-09-03 20:56:05 +02:00
setup.asciidoc [DOCS] Starting Elasticsearch (#31701) 2018-07-03 13:40:37 -07:00
testing.asciidoc [Docs] Unify spelling of Elasticsearch (#27567) 2017-11-29 09:44:25 +01:00
upgrade.asciidoc Revert "[DOCS] Added 6.3 info & updated the upgrade table. (#30940)" 2018-06-11 22:04:36 -04:00