elasticsearch/docs/reference/indices
Lee Hinman d3ccada06f
Add template simulation API for simulating template composition (#56842)
This adds an API for simulating template composition with or without an index template.

It looks like:

```
POST /_index_template/_simulate/my-template
```

To simulate a template named `my-template` that already exists, or, to simulate a template that does
not already exist:

```
POST /_index_template/_simulate
{
  "index_patterns": ["my-index"]
  "composed_of": ["ct1", "ct2"],
}
```

This is related to #55686, which adds an API to simulate composition based on an index name (hence
the `_simulate_index` vs `_simulate`).

This commit also adds reference documentation for both simulation APIs.

Relates to #53101
Resolves #56390
Resolves #56255
2020-05-18 15:11:42 -06:00
..
apis [Docs] Clarify default value for `allow_no_indices` (#52635) 2020-02-24 11:37:29 +01:00
add-alias.asciidoc [DOCS] Update tagged region for index alias desc (#46886) 2019-09-19 15:23:52 -04:00
alias-exists.asciidoc [Docs] Clarify default value for `allow_no_indices` (#52635) 2020-02-24 11:37:29 +01:00
aliases.asciidoc Implement hidden aliases (#52547) 2020-03-03 16:30:22 -07:00
analyze.asciidoc Correct the type of the 'analyzer' parameter in the _analyze docs. (#56650) 2020-05-13 11:01:55 -07:00
clearcache.asciidoc [Docs] Clarify default value for `allow_no_indices` (#52635) 2020-02-24 11:37:29 +01:00
clone-index.asciidoc [DOCS] Reformat clone index API docs (#46762) 2019-09-25 12:36:23 -04:00
close.asciidoc [Docs] Clarify default value for `allow_no_indices` (#52635) 2020-02-24 11:37:29 +01:00
component-templates.asciidoc Initial documentation for index templates V2 (#55755) 2020-04-28 15:58:40 -06:00
create-data-stream.asciidoc Docs for data stream REST APIs (#55557) 2020-05-13 07:51:39 -05:00
create-index.asciidoc [DOCS] Create index name required (#55886) 2020-04-29 13:34:18 +02:00
delete-alias.asciidoc [DOCS] Update tagged region for index alias desc (#46886) 2019-09-19 15:23:52 -04:00
delete-data-stream.asciidoc Docs for data stream REST APIs (#55557) 2020-05-13 07:51:39 -05:00
delete-index-template.asciidoc Initial documentation for index templates V2 (#55755) 2020-04-28 15:58:40 -06:00
delete-index.asciidoc [Docs] Clarify default value for `allow_no_indices` (#52635) 2020-02-24 11:37:29 +01:00
flush.asciidoc [Docs] Clarify default value for `allow_no_indices` (#52635) 2020-02-24 11:37:29 +01:00
forcemerge.asciidoc [Docs] Clarify default value for `allow_no_indices` (#52635) 2020-02-24 11:37:29 +01:00
get-alias.asciidoc [Docs] Clarify default value for `allow_no_indices` (#52635) 2020-02-24 11:37:29 +01:00
get-data-stream.asciidoc Rename endpoint from plural "_data_streams" to singular "_data_stream" (#56762) 2020-05-15 08:23:43 -05:00
get-field-mapping.asciidoc Remove local parameter for get field mapping API (#55100) 2020-04-15 12:02:10 +10:00
get-index-template.asciidoc Initial documentation for index templates V2 (#55755) 2020-04-28 15:58:40 -06:00
get-index.asciidoc [Docs] Clarify default value for `allow_no_indices` (#52635) 2020-02-24 11:37:29 +01:00
get-mapping.asciidoc [Docs] Clarify default value for `allow_no_indices` (#52635) 2020-02-24 11:37:29 +01:00
get-settings.asciidoc [Docs] Clarify default value for `allow_no_indices` (#52635) 2020-02-24 11:37:29 +01:00
index-templates.asciidoc Add template simulation API for simulating template composition (#56842) 2020-05-18 15:11:42 -06:00
indices-exists.asciidoc [Docs] Clarify default value for `allow_no_indices` (#52635) 2020-02-24 11:37:29 +01:00
open-close.asciidoc [Docs] Clarify default value for `allow_no_indices` (#52635) 2020-02-24 11:37:29 +01:00
put-mapping.asciidoc [Docs] Clarify default value for `allow_no_indices` (#52635) 2020-02-24 11:37:29 +01:00
recovery.asciidoc [DOCS] Move snapshot-restore out of modules. (#49618) 2020-01-09 16:12:02 -08:00
refresh.asciidoc [Docs] Clarify default value for `allow_no_indices` (#52635) 2020-02-24 11:37:29 +01:00
rollover-index.asciidoc Update rollover index API docs for data streams (#55551) 2020-05-14 07:12:55 -05:00
segments.asciidoc [Docs] Clarify default value for `allow_no_indices` (#52635) 2020-02-24 11:37:29 +01:00
shard-stores.asciidoc [Docs] Clarify default value for `allow_no_indices` (#52635) 2020-02-24 11:37:29 +01:00
shrink-index.asciidoc [DOCS] Reformat shrink index API docs (#46711) 2019-10-04 12:07:46 -04:00
split-index.asciidoc [DOCS] Correct typo in split index API docs (#48894) 2019-11-07 15:26:55 -05:00
stats.asciidoc
synced-flush.asciidoc Goodbye and thank you synced flush! (#50882) 2020-01-16 09:43:07 -05:00
template-exists.asciidoc
templates.asciidoc Remove prefer_v2_templates query string parameter (#56546) 2020-05-11 14:56:48 -06:00
update-settings.asciidoc [Docs] Clarify default value for `allow_no_indices` (#52635) 2020-02-24 11:37:29 +01:00