OpenSearch/docs/reference/indices
Nik Everett 4b1c116461 Generate and run tests from the docs
Adds infrastructure so `gradle :docs:check` will extract tests from
snippets in the documentation and execute the tests. This is included
in `gradle check` so it should happen on CI and during a normal build.

By default each `// AUTOSENSE` snippet creates a unique REST test. These
tests are executed in a random order and the cluster is wiped between
each one. If multiple snippets chain together into a test you can annotate
all snippets after the first with `// TEST[continued]` to have the
generated tests for both snippets joined.

Snippets marked as `// TESTRESPONSE` are checked against the response
of the last action.

See docs/README.asciidoc for lots more.

Closes #12583. That issue is about catching bugs in the docs during build.
This catches *some* bugs in the docs during build which is a good start.
2016-05-05 13:58:03 -04:00
..
aliases.asciidoc Document 5.0 mapping changes. 2016-03-22 16:22:58 +01:00
analyze.asciidoc Generate and run tests from the docs 2016-05-05 13:58:03 -04:00
clearcache.asciidoc Merge pull request #17030 from 36degrees/patch-1 2016-03-09 15:34:15 +01:00
create-index.asciidoc Fixed the documentation formatting. (#17990) 2016-04-29 18:07:48 +02:00
delete-index.asciidoc Merge pull request #15856 from marcbachmann/patch-1 2016-01-10 10:48:32 +01:00
flush.asciidoc Generate and run tests from the docs 2016-05-05 13:58:03 -04:00
forcemerge.asciidoc Add Force Merge API, deprecate Optimize API 2015-10-20 09:00:24 -06:00
get-field-mapping.asciidoc Document 5.0 mapping changes. 2016-03-22 16:22:58 +01:00
get-index.asciidoc Remove warmers and the warmer API. 2016-01-07 09:57:07 +01:00
get-mapping.asciidoc Docs: Removed all the added/deprecated tags from 1.x 2014-09-26 21:04:42 +02:00
get-settings.asciidoc Update get-settings.asciidoc 2015-10-02 16:46:45 +02:00
indices-exists.asciidoc [DOCS] add -i flag to more curl HEAD calls 2015-03-21 08:56:20 +01:00
open-close.asciidoc Add option to disable closing indices 2015-10-16 22:10:51 +02:00
put-mapping.asciidoc Generate and run tests from the docs 2016-05-05 13:58:03 -04:00
recovery.asciidoc Consolidate shard level abstractions 2015-06-24 15:18:04 +02:00
refresh.asciidoc Rename RobinEngine and friends to InternalEngine 2014-01-13 15:49:10 +01:00
segments.asciidoc Update segments.asciidoc 2016-01-28 13:33:01 +01:00
shadow-replicas.asciidoc [DOCS] Add blurb about `data_path` not needing to include index name 2016-02-21 13:11:45 -07:00
shard-stores.asciidoc Fix typos in docs. 2016-02-09 02:07:32 -08:00
stats.asciidoc document suggest stats being merged with search stats 2016-03-23 16:37:57 -04:00
templates.asciidoc Generate and run tests from the docs 2016-05-05 13:58:03 -04:00
types-exists.asciidoc [DOCS] add -i flag to curl HEAD call 2015-03-21 08:56:12 +01:00
update-settings.asciidoc Add Force Merge API, deprecate Optimize API 2015-10-20 09:00:24 -06:00
upgrade.asciidoc Docs: Updated the upgrade API docs to explain that the reindex API should be used instead 2016-03-31 14:34:31 +02:00