Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove include_type_name from the REST API spec and docs. #48828

Merged
merged 2 commits into from
Nov 12, 2019
Merged

Remove include_type_name from the REST API spec and docs. #48828

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5f0643c
Remove include_type_name from the REST API spec and docs.
jtibshirani Nov 1, 2019
41768d7
Merge remote-tracking branch 'upstream/master' into include-type-name
jtibshirani Nov 12, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions docs/reference/indices/create-index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down Expand Up @@ -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 <<removal-of-types>>.

[[create-index-aliases]]
===== Aliases

Expand Down
2 changes: 0 additions & 2 deletions docs/reference/indices/get-field-mapping.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`::
Expand Down
2 changes: 0 additions & 2 deletions docs/reference/indices/get-index-template.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
7 changes: 0 additions & 7 deletions docs/reference/indices/get-index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <<removal-of-types>>.


[[get-index-api-request]]
==== {api-request-title}

Expand Down Expand Up @@ -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]
Expand Down
7 changes: 0 additions & 7 deletions docs/reference/indices/get-mapping.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <<removal-of-types>>.


[[get-mapping-api-request]]
==== {api-request-title}

Expand All @@ -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]
Expand Down
8 changes: 0 additions & 8 deletions docs/reference/indices/put-mapping.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <<removal-of-types>>.


[[put-mapping-api-request]]
==== {api-request-title}

Expand All @@ -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]
Expand Down
2 changes: 0 additions & 2 deletions docs/reference/indices/rollover-index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
2 changes: 0 additions & 2 deletions docs/reference/indices/templates.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 0 additions & 7 deletions docs/reference/rest-api/common-parms.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <<removal-of-types>>.]
(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
Expand Down
4 changes: 0 additions & 4 deletions rest-api-spec/src/main/resources/rest-api-spec/api/indices.create.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Expand Down
4 changes: 0 additions & 4 deletions rest-api-spec/src/main/resources/rest-api-spec/api/indices.get.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)"
Expand Down
4 changes: 0 additions & 4 deletions rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_field_mapping.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
4 changes: 0 additions & 4 deletions rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)"
Expand Down
4 changes: 0 additions & 4 deletions rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)"
Expand Down
4 changes: 0 additions & 4 deletions rest-api-spec/src/main/resources/rest-api-spec/api/indices.rollover.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down