From 5f0643c5d33855d34e0df6fd3aced601742e5a81 Mon Sep 17 00:00:00 2001 From: Julie Tibshirani Date: Fri, 1 Nov 2019 16:19:42 -0700 Subject: [PATCH] Remove include_type_name from the REST API spec and docs. --- docs/reference/indices/create-index.asciidoc | 6 ------ docs/reference/indices/get-field-mapping.asciidoc | 2 -- docs/reference/indices/get-index-template.asciidoc | 2 -- docs/reference/indices/get-index.asciidoc | 7 ------- docs/reference/indices/get-mapping.asciidoc | 7 ------- docs/reference/indices/put-mapping.asciidoc | 8 -------- docs/reference/indices/rollover-index.asciidoc | 2 -- docs/reference/indices/templates.asciidoc | 2 -- docs/reference/rest-api/common-parms.asciidoc | 7 ------- .../main/resources/rest-api-spec/api/indices.create.json | 4 ---- .../src/main/resources/rest-api-spec/api/indices.get.json | 4 ---- .../rest-api-spec/api/indices.get_field_mapping.json | 4 ---- .../resources/rest-api-spec/api/indices.get_template.json | 4 ---- .../resources/rest-api-spec/api/indices.put_template.json | 4 ---- .../resources/rest-api-spec/api/indices.rollover.json | 4 ---- 15 files changed, 67 deletions(-) diff --git a/docs/reference/indices/create-index.asciidoc b/docs/reference/indices/create-index.asciidoc index afb7ab91232b4..6009189c4fe03 100644 --- a/docs/reference/indices/create-index.asciidoc +++ b/docs/reference/indices/create-index.asciidoc @@ -51,8 +51,6 @@ Index names must meet the following criteria: [[indices-create-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=include-type-name] - include::{docdir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] @@ -135,10 +133,6 @@ PUT /test } -------------------------------------------------- -NOTE: Before 7.0.0, the 'mappings' definition used to include a type name. Although specifying -types in requests is now deprecated, a type can still be provided if the request parameter -include_type_name is set. For more details, please see <>. - [[create-index-aliases]] ===== Aliases diff --git a/docs/reference/indices/get-field-mapping.asciidoc b/docs/reference/indices/get-field-mapping.asciidoc index c0e5e6d46a5c5..eebcc70208b17 100644 --- a/docs/reference/indices/get-field-mapping.asciidoc +++ b/docs/reference/indices/get-field-mapping.asciidoc @@ -40,8 +40,6 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] -include::{docdir}/rest-api/common-parms.asciidoc[tag=include-type-name] - include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] `include_defaults`:: diff --git a/docs/reference/indices/get-index-template.asciidoc b/docs/reference/indices/get-index-template.asciidoc index 8352981558b0e..6549f47c4b566 100644 --- a/docs/reference/indices/get-index-template.asciidoc +++ b/docs/reference/indices/get-index-template.asciidoc @@ -46,8 +46,6 @@ or use a value of `_all` or `*`. include::{docdir}/rest-api/common-parms.asciidoc[tag=flat-settings] -include::{docdir}/rest-api/common-parms.asciidoc[tag=include-type-name] - include::{docdir}/rest-api/common-parms.asciidoc[tag=local] include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] diff --git a/docs/reference/indices/get-index.asciidoc b/docs/reference/indices/get-index.asciidoc index 7d5a1c3561933..f405317c0fcf7 100644 --- a/docs/reference/indices/get-index.asciidoc +++ b/docs/reference/indices/get-index.asciidoc @@ -12,11 +12,6 @@ GET /twitter -------------------------------------------------- // TEST[setup:twitter] -NOTE: Before 7.0.0, the 'mappings' definition used to include a type name. Although mappings -in responses no longer contain a type name by default, you can still request the old format -through the parameter include_type_name. For more details, please see <>. - - [[get-index-api-request]] ==== {api-request-title} @@ -49,8 +44,6 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=flat-settings] include::{docdir}/rest-api/common-parms.asciidoc[tag=include-defaults] -include::{docdir}/rest-api/common-parms.asciidoc[tag=include-type-name] - include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] include::{docdir}/rest-api/common-parms.asciidoc[tag=local] diff --git a/docs/reference/indices/get-mapping.asciidoc b/docs/reference/indices/get-mapping.asciidoc index 81b2cd826d900..5f6c8136d48ee 100644 --- a/docs/reference/indices/get-mapping.asciidoc +++ b/docs/reference/indices/get-mapping.asciidoc @@ -12,11 +12,6 @@ GET /twitter/_mapping -------------------------------------------------- // TEST[setup:twitter] -NOTE: Before 7.0.0, the 'mappings' definition used to include a type name. Although mappings -in responses no longer contain a type name by default, you can still request the old format -through the parameter `include_type_name`. For more details, please see <>. - - [[get-mapping-api-request]] ==== {api-request-title} @@ -40,8 +35,6 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=include-type-name] - include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] include::{docdir}/rest-api/common-parms.asciidoc[tag=local] diff --git a/docs/reference/indices/put-mapping.asciidoc b/docs/reference/indices/put-mapping.asciidoc index 62258d9f85e28..f0132d5af0878 100644 --- a/docs/reference/indices/put-mapping.asciidoc +++ b/docs/reference/indices/put-mapping.asciidoc @@ -20,12 +20,6 @@ PUT /twitter/_mapping ---- // TEST[setup:twitter] -NOTE: Before 7.0.0, the 'mappings' definition used to include a type name. -Although specifying types in requests is now deprecated, a type can still be -provided if the request parameter `include_type_name` is set. For more details, -please see <>. - - [[put-mapping-api-request]] ==== {api-request-title} @@ -52,8 +46,6 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `open`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=include-type-name] - include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] diff --git a/docs/reference/indices/rollover-index.asciidoc b/docs/reference/indices/rollover-index.asciidoc index f40095be5420d..c4c7fb980bebb 100644 --- a/docs/reference/indices/rollover-index.asciidoc +++ b/docs/reference/indices/rollover-index.asciidoc @@ -113,8 +113,6 @@ the request checks whether the index matches provided conditions but does not perform a rollover. Defaults to `false`. -include::{docdir}/rest-api/common-parms.asciidoc[tag=include-type-name] - include::{docdir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards] include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] diff --git a/docs/reference/indices/templates.asciidoc b/docs/reference/indices/templates.asciidoc index 0f33b21d0131b..e31b34d05b1b6 100644 --- a/docs/reference/indices/templates.asciidoc +++ b/docs/reference/indices/templates.asciidoc @@ -86,8 +86,6 @@ Defaults to `false`. include::{docdir}/rest-api/common-parms.asciidoc[tag=flat-settings] -include::{docdir}/rest-api/common-parms.asciidoc[tag=include-type-name] - `order`:: (Optional,integer) Order in which {es} applies this template diff --git a/docs/reference/rest-api/common-parms.asciidoc b/docs/reference/rest-api/common-parms.asciidoc index 0921a7d289cf9..0c9400bbf62f7 100644 --- a/docs/reference/rest-api/common-parms.asciidoc +++ b/docs/reference/rest-api/common-parms.asciidoc @@ -281,13 +281,6 @@ each one of the Lucene index files (only applies if segment stats are requested). Defaults to `false`. end::include-segment-file-sizes[] -tag::include-type-name[] -`include_type_name`:: -deprecated:[7.0.0, Mapping types have been deprecated. See <>.] -(Optional, boolean) If `true`, a mapping type is expected in the body of -mappings. Defaults to `false`. -end::include-type-name[] - tag::include-unloaded-segments[] `include_unloaded_segments`:: (Optional, boolean) If `true`, the response includes information from segments diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.create.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.create.json index 2b9e8617a661c..922183d628ac6 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.create.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.create.json @@ -22,10 +22,6 @@ ] }, "params":{ - "include_type_name":{ - "type":"boolean", - "description":"Whether a type should be expected in the body of the mappings." - }, "wait_for_active_shards":{ "type":"string", "description":"Set the number of active shards to wait for before the operation returns." diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get.json index 20f243c2b595f..ccacf91d93095 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get.json @@ -22,10 +22,6 @@ ] }, "params":{ - "include_type_name":{ - "type":"boolean", - "description":"Whether to add the type name to the response (default: false)" - }, "local":{ "type":"boolean", "description":"Return local information, do not retrieve the state from master node (default: false)" diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_field_mapping.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_field_mapping.json index 9b210b893275e..4c5191f2f320a 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_field_mapping.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_field_mapping.json @@ -38,10 +38,6 @@ ] }, "params":{ - "include_type_name":{ - "type":"boolean", - "description":"Whether a type should be returned in the body of the mappings." - }, "include_defaults":{ "type":"boolean", "description":"Whether the default mapping values should be returned as well" diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_template.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_template.json index 9e07ae663ff8f..337016763ad0a 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_template.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_template.json @@ -28,10 +28,6 @@ ] }, "params":{ - "include_type_name":{ - "type":"boolean", - "description":"Whether a type should be returned in the body of the mappings." - }, "flat_settings":{ "type":"boolean", "description":"Return settings in flat format (default: false)" diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_template.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_template.json index 18f140538c339..133776199b3ac 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_template.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_template.json @@ -23,10 +23,6 @@ ] }, "params":{ - "include_type_name":{ - "type":"boolean", - "description":"Whether a type should be returned in the body of the mappings." - }, "order":{ "type":"number", "description":"The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)" diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.rollover.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.rollover.json index 4ed1f9b490969..fef1f03d1c9a7 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.rollover.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.rollover.json @@ -38,10 +38,6 @@ ] }, "params":{ - "include_type_name":{ - "type":"boolean", - "description":"Whether a type should be included in the body of the mappings." - }, "timeout":{ "type":"time", "description":"Explicit operation timeout"