Skip to content

Commit 70de419

Browse files
committed
[DOCS] More description for legacy put template
1 parent 050bf3b commit 70de419

File tree

4 files changed

+32
-5
lines changed

4 files changed

+32
-5
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 8 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/schema.json

Lines changed: 11 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/_doc_ids/table.csv

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -212,6 +212,7 @@ index-modules,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/i
212212
index,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index.html
213213
indexing-buffer,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indexing-buffer.html
214214
index-modules-merge,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-modules-merge.html
215+
index-templates,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-templates.html
215216
indices-aliases,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-aliases.html
216217
indices-analyze,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-analyze.html
217218
indices-clearcache,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-clearcache.html

specification/indices/put_template/IndicesPutTemplateRequest.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,20 @@ import { Duration } from '@_types/Time'
2929
/**
3030
* Create or update an index template.
3131
* Index templates define settings, mappings, and aliases that can be applied automatically to new indices.
32+
* Elasticsearch applies templates to new indices based on an index pattern that matches the index name.
33+
*
34+
* IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.
35+
*
36+
* Composable templates always take precedence over legacy templates.
37+
* If no composable template matches a new index, matching legacy templates are applied according to their order.
38+
*
39+
* Index templates are only applied during index creation.
40+
* Changes to index templates do not affect existing indices.
41+
* Settings and mappings specified in create index API requests override any settings or mappings specified in an index template.
3242
* @rest_spec_name indices.put_template
3343
* @availability stack stability=stable
44+
* @cluster_privileges manage_index_templates, manage
45+
* @ext_doc_id index-templates
3446
*/
3547
export interface Request extends RequestBase {
3648
path_parts: {

0 commit comments

Comments
 (0)