Skip to content

Commit 33a7f06

Browse files
authored
Remove include_type_name from the REST API spec and docs. (#48828)
In #48632 we removed support for `include_type_name` in the REST API. This PR removes it from the API spec and documentation.
1 parent b6c6387 commit 33a7f06

15 files changed

+0
-67
lines changed

docs/reference/indices/create-index.asciidoc

-6
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,6 @@ Index names must meet the following criteria:
5151
[[indices-create-api-query-params]]
5252
==== {api-query-parms-title}
5353

54-
include::{docdir}/rest-api/common-parms.asciidoc[tag=include-type-name]
55-
5654
include::{docdir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards]
5755

5856
include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
@@ -135,10 +133,6 @@ PUT /test
135133
}
136134
--------------------------------------------------
137135

138-
NOTE: Before 7.0.0, the 'mappings' definition used to include a type name. Although specifying
139-
types in requests is now deprecated, a type can still be provided if the request parameter
140-
include_type_name is set. For more details, please see <<removal-of-types>>.
141-
142136
[[create-index-aliases]]
143137
===== Aliases
144138

docs/reference/indices/get-field-mapping.asciidoc

-2
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,6 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
4040

4141
include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
4242

43-
include::{docdir}/rest-api/common-parms.asciidoc[tag=include-type-name]
44-
4543
include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]
4644

4745
`include_defaults`::

docs/reference/indices/get-index-template.asciidoc

-2
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,6 @@ or use a value of `_all` or `*`.
4646

4747
include::{docdir}/rest-api/common-parms.asciidoc[tag=flat-settings]
4848

49-
include::{docdir}/rest-api/common-parms.asciidoc[tag=include-type-name]
50-
5149
include::{docdir}/rest-api/common-parms.asciidoc[tag=local]
5250

5351
include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout]

docs/reference/indices/get-index.asciidoc

-7
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,6 @@ GET /twitter
1212
--------------------------------------------------
1313
// TEST[setup:twitter]
1414

15-
NOTE: Before 7.0.0, the 'mappings' definition used to include a type name. Although mappings
16-
in responses no longer contain a type name by default, you can still request the old format
17-
through the parameter include_type_name. For more details, please see <<removal-of-types>>.
18-
19-
2015
[[get-index-api-request]]
2116
==== {api-request-title}
2217

@@ -49,8 +44,6 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=flat-settings]
4944

5045
include::{docdir}/rest-api/common-parms.asciidoc[tag=include-defaults]
5146

52-
include::{docdir}/rest-api/common-parms.asciidoc[tag=include-type-name]
53-
5447
include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]
5548

5649
include::{docdir}/rest-api/common-parms.asciidoc[tag=local]

docs/reference/indices/get-mapping.asciidoc

-7
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,6 @@ GET /twitter/_mapping
1212
--------------------------------------------------
1313
// TEST[setup:twitter]
1414

15-
NOTE: Before 7.0.0, the 'mappings' definition used to include a type name. Although mappings
16-
in responses no longer contain a type name by default, you can still request the old format
17-
through the parameter `include_type_name`. For more details, please see <<removal-of-types>>.
18-
19-
2015
[[get-mapping-api-request]]
2116
==== {api-request-title}
2217

@@ -40,8 +35,6 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
4035
+
4136
Defaults to `open`.
4237

43-
include::{docdir}/rest-api/common-parms.asciidoc[tag=include-type-name]
44-
4538
include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]
4639

4740
include::{docdir}/rest-api/common-parms.asciidoc[tag=local]

docs/reference/indices/put-mapping.asciidoc

-8
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,6 @@ PUT /twitter/_mapping
2020
----
2121
// TEST[setup:twitter]
2222

23-
NOTE: Before 7.0.0, the 'mappings' definition used to include a type name.
24-
Although specifying types in requests is now deprecated, a type can still be
25-
provided if the request parameter `include_type_name` is set. For more details,
26-
please see <<removal-of-types>>.
27-
28-
2923
[[put-mapping-api-request]]
3024
==== {api-request-title}
3125

@@ -52,8 +46,6 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
5246
+
5347
Defaults to `open`.
5448

55-
include::{docdir}/rest-api/common-parms.asciidoc[tag=include-type-name]
56-
5749
include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]
5850

5951
include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]

docs/reference/indices/rollover-index.asciidoc

-2
Original file line numberDiff line numberDiff line change
@@ -113,8 +113,6 @@ the request checks whether the index matches provided conditions
113113
but does not perform a rollover.
114114
Defaults to `false`.
115115

116-
include::{docdir}/rest-api/common-parms.asciidoc[tag=include-type-name]
117-
118116
include::{docdir}/rest-api/common-parms.asciidoc[tag=wait_for_active_shards]
119117

120118
include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]

docs/reference/indices/templates.asciidoc

-2
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,6 @@ Defaults to `false`.
8686

8787
include::{docdir}/rest-api/common-parms.asciidoc[tag=flat-settings]
8888

89-
include::{docdir}/rest-api/common-parms.asciidoc[tag=include-type-name]
90-
9189
`order`::
9290
(Optional,integer)
9391
Order in which {es} applies this template

docs/reference/rest-api/common-parms.asciidoc

-7
Original file line numberDiff line numberDiff line change
@@ -281,13 +281,6 @@ each one of the Lucene index files (only applies if segment stats are
281281
requested). Defaults to `false`.
282282
end::include-segment-file-sizes[]
283283

284-
tag::include-type-name[]
285-
`include_type_name`::
286-
deprecated:[7.0.0, Mapping types have been deprecated. See <<removal-of-types>>.]
287-
(Optional, boolean) If `true`, a mapping type is expected in the body of
288-
mappings. Defaults to `false`.
289-
end::include-type-name[]
290-
291284
tag::include-unloaded-segments[]
292285
`include_unloaded_segments`::
293286
(Optional, boolean) If `true`, the response includes information from segments

rest-api-spec/src/main/resources/rest-api-spec/api/indices.create.json

-4
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,6 @@
2222
]
2323
},
2424
"params":{
25-
"include_type_name":{
26-
"type":"boolean",
27-
"description":"Whether a type should be expected in the body of the mappings."
28-
},
2925
"wait_for_active_shards":{
3026
"type":"string",
3127
"description":"Set the number of active shards to wait for before the operation returns."

rest-api-spec/src/main/resources/rest-api-spec/api/indices.get.json

-4
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,6 @@
2222
]
2323
},
2424
"params":{
25-
"include_type_name":{
26-
"type":"boolean",
27-
"description":"Whether to add the type name to the response (default: false)"
28-
},
2925
"local":{
3026
"type":"boolean",
3127
"description":"Return local information, do not retrieve the state from master node (default: false)"

rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_field_mapping.json

-4
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,6 @@
3838
]
3939
},
4040
"params":{
41-
"include_type_name":{
42-
"type":"boolean",
43-
"description":"Whether a type should be returned in the body of the mappings."
44-
},
4541
"include_defaults":{
4642
"type":"boolean",
4743
"description":"Whether the default mapping values should be returned as well"

rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_template.json

-4
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,6 @@
2828
]
2929
},
3030
"params":{
31-
"include_type_name":{
32-
"type":"boolean",
33-
"description":"Whether a type should be returned in the body of the mappings."
34-
},
3531
"flat_settings":{
3632
"type":"boolean",
3733
"description":"Return settings in flat format (default: false)"

rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_template.json

-4
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,6 @@
2323
]
2424
},
2525
"params":{
26-
"include_type_name":{
27-
"type":"boolean",
28-
"description":"Whether a type should be returned in the body of the mappings."
29-
},
3026
"order":{
3127
"type":"number",
3228
"description":"The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)"

rest-api-spec/src/main/resources/rest-api-spec/api/indices.rollover.json

-4
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,6 @@
3838
]
3939
},
4040
"params":{
41-
"include_type_name":{
42-
"type":"boolean",
43-
"description":"Whether a type should be included in the body of the mappings."
44-
},
4541
"timeout":{
4642
"type":"time",
4743
"description":"Explicit operation timeout"

0 commit comments

Comments
 (0)