Skip to content

Commit efeb198

Browse files
authored
[DOCS] Combine 8.0 breaking changes for mapping type endpoints (#81730)
Combines several 8.0 breaking changes for the removal of API endpoints that contain mapping types. These items were separate because we previously organized breaking changes by area. This is a follow-on to #79162.
1 parent 4b0864d commit efeb198

File tree

1 file changed

+144
-40
lines changed

1 file changed

+144
-40
lines changed

docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc

Lines changed: 144 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,149 @@ Use the replacement REST API endpoints. Requests submitted to the `_xpack`
2020
API endpoints will return an error.
2121
====
2222

23+
[[remove-mapping-type-api-endpoints]]
24+
.REST API endpoints containing mapping types have been removed.
25+
[%collapsible]
26+
====
27+
*Details* +
28+
Mapping types have been removed. API endpoints that contain a mapping type have
29+
also been removed. Use a typeless endpoint instead.
30+
31+
[options="header",cols="<1,<3,<1"]
32+
|====
33+
| API | Typed API endpoint | Typeless API endpoint
34+
35+
| {ref}/docs-bulk.html[Bulk]
36+
| `<target>/<type>/_bulk`
37+
| `<target>/_bulk`
38+
39+
| {ref}/search-count.html[Count]
40+
| `<target>/<type>/_count`
41+
| `<target>/_count`
42+
43+
| {ref}/docs-delete.html[Delete]
44+
| `<index>/<type>/<_id>`
45+
| `<index>/_doc/<_id>`
46+
47+
| {ref}/docs-delete-by-query.html[Delete by query]
48+
| `<target>/<type>/_delete_by_query`
49+
| `<target>/_delete_by_query`
50+
51+
| {ref}/search-explain.html[Explain]
52+
| `<index>/<type>/<_id>/_explain`
53+
| `<index>/_explain/<_id>`
54+
55+
| {ref}/docs-get.html[Get]
56+
| `<index>/<type>/<_id>`
57+
| `<index>/_doc/<_id>`
58+
59+
|
60+
| `<index>/<type>/<_id>/_source`
61+
| `<index>/_source/<_id>`
62+
63+
| {ref}/indices-get-field-mapping.html[Get field mapping]
64+
| `_mapping/<type>/field/<field>`
65+
| `_mapping/field/<field>`
66+
67+
|
68+
| `<target>/_mapping/<type>/field/<field>`
69+
| `<target>/_mapping/field/<field>`
70+
71+
| {ref}/indices-get-mapping.html[Get mapping]
72+
| `_mapping/<type>`
73+
| `_mapping` or `<target>/_mapping`
74+
75+
|
76+
| `<target>/<type>/_mapping`
77+
| `<target>/_mapping`
78+
79+
|
80+
| `<target>/_mapping/<type>`
81+
| `<target>/_mapping`
82+
83+
| {ref}/graph-explore-api.html[Graph explore]
84+
| `<index>/<type>/_graph/explore`
85+
| `<index>/_graph/explore`
86+
87+
| {ref}/docs-index_.html[Index]
88+
| `<target>/<type>/<_id>/_create`
89+
| `<target>/_create/<_id>`
90+
91+
|
92+
| `<target>/<type>`
93+
| `<target>/_doc`
94+
95+
|
96+
| `<target>/<type>/<_id>`
97+
| `<target>/_doc/<_id>`
98+
99+
| {ref}/docs-multi-get.html[Multi get]
100+
| `<index>/<type>/_mget`
101+
| `<index>/_mget`
102+
103+
| {ref}/search-multi-search.html[Multi search]
104+
| `<target>/<type>/_msearch`
105+
| `<target>/_msearch`
106+
107+
| {ref}/multi-search-template.html[Multi search template]
108+
| `<target>/<type>/_msearch/template`
109+
| `<target>/_msearch/template`
110+
111+
| {ref}/docs-multi-termvectors.html[Multi term vectors]
112+
| `<index>/<type>/_mtermvectors`
113+
| `<index>/_mtermvectors`
114+
115+
| {ref}/rollup-search.html[Rollup search]
116+
| `<target>/<type>/_rollup_search`
117+
| `<target>/_rollup_search`
118+
119+
| {ref}/search-search.html[Search]
120+
| `<target>/<type>/_search`
121+
| `<target>/_search`
122+
123+
| {ref}/search-template-api.html[Search template]
124+
| `<target>/<type>/_search/template`
125+
| `<target>/_search/template`
126+
127+
| {ref}/docs-termvectors.html[Term vectors]
128+
| `<index>/<mapping_type>/<_id>/_termvectors`
129+
| `<index>/_termvectors<_id>`
130+
131+
|
132+
| `<index>/<mapping_type>/_termvectors`
133+
| `<index>/_termvectors`
134+
135+
| {ref}/docs-update.html[Update]
136+
| `<index>/<type>/<_id>/_update`
137+
| `<index>/_update/<_id>`
138+
139+
| {ref}/docs-update-by-query.html[Update by query]
140+
| `<target>/<type>/_update_by_query`
141+
| `<target>/_update_by_query`
142+
143+
| {ref}/indices-put-mapping.html[Update mapping]
144+
| `<target>/<type>/_mapping`
145+
| `<target>/_mapping`
146+
147+
|
148+
| `<target>/_mapping/<type>`
149+
| `<target>/_mapping`
150+
151+
|
152+
| `_mapping/<type>`
153+
| `<target>/_mapping`
154+
155+
| {ref}/search-validate.html[Validate]
156+
| `<target>/<type>/_validate/query`
157+
| `<target>/_validate/query`
158+
159+
|====
160+
161+
*Impact* +
162+
Update your application to use typeless REST API endpoints. Requests to
163+
endpoints that contain a mapping type will return an error.
164+
====
165+
23166
[[remove-term-order-key]]
24167
.The `terms` aggregation no longer supports the `_term` order key.
25168
[%collapsible]
@@ -309,19 +452,6 @@ To avoid deprecation warnings, remove the parameter from your ingest pipelines.
309452
If a pipeline specifies an `ecs` value, the value is ignored.
310453
====
311454

312-
.Mapping API endpoints containing mapping types have been removed.
313-
[%collapsible]
314-
====
315-
*Details* +
316-
The typed REST endpoints of the update mapping, get mapping and get field mapping
317-
APIs have been removed in favour of their typeless REST endpoints, since indexes
318-
no longer contain types, these typed endpoints are obsolete.
319-
320-
*Impact* +
321-
Use the typeless REST endpoints to update and retrieve mappings. Requests
322-
submitted to the typed mapping API endpoints will return an error.
323-
====
324-
325455
.The `include_type_name` query parameter has been removed.
326456
[%collapsible]
327457
====
@@ -349,17 +479,6 @@ reindex generates remote search requests.
349479
Specify unencoded index names for reindex from remote requests.
350480
====
351481

352-
.Reindex-related REST API endpoints containing mapping types have been removed.
353-
[%collapsible]
354-
====
355-
*Details* +
356-
The `/{index}/{type}/_delete_by_query` and `/{index}/{type}/_update_by_query` REST endpoints have been removed in favour of `/{index}/_delete_by_query` and `/{index}/_update_by_query`, since indexes no longer contain types, these typed endpoints are obsolete.
357-
358-
*Impact* +
359-
Use the replacement REST API endpoints. Requests submitted to API endpoints
360-
that contain a mapping type will return an error.
361-
====
362-
363482
.In the reindex, delete by query, and update by query APIs, the `size` parameter has been renamed.
364483
[%collapsible]
365484
====
@@ -627,21 +746,6 @@ Aggregating and sorting on `_id` should be avoided. As an alternative, the
627746
enabled (note that this does not apply to auto-generated IDs).
628747
====
629748

630-
.Search-related REST API endpoints containing mapping types have been removed.
631-
[%collapsible]
632-
====
633-
*Details* +
634-
The `/{index}/{type}/_search`, `/{index}/{type}/_msearch`, `/{index}/{type}/_search/template` and `/{index}/{type}/_msearch/template` REST endpoints have been removed in favour of `/{index}/_search`, `/{index}/_msearch`, `/{index}/_search/template` and `/{index}/_msearch/template`; since indexes no longer contain types, these typed endpoints are obsolete..
635-
636-
The `/{index}/{type}/_termvectors`, `/{index}/{type}/{id}/_termvectors` and `/{index}/{type}/_mtermvectors` REST endpoints have been removed in favour of `/{index}/_termvectors`, `/{index}/{id}/_termvectors` and `/{index}/_mtermvectors`; since indexes no longer contain types, these typed endpoints are obsolete..
637-
638-
The `/{index}/{type}/{doc}` and `/{index}/{type}/_mget` REST endpoints have been removed in favour of `/{index}/_doc/{doc}` and `/{index}/_mget`; since indexes no longer contain types, these typed endpoints are obsolete.
639-
640-
*Impact* +
641-
Use the replacement REST API endpoints. Requests submitted to API endpoints that
642-
contain a mapping type will return an error.
643-
====
644-
645749
.The `common` query has been removed.
646750
[%collapsible]
647751
====
@@ -893,7 +997,7 @@ snapshot request. Requests that include these parameters will return an error.
893997
====
894998
*Details* +
895999
The repository stats API has been removed. We deprecated this experimental API
896-
in 7.10.0.
1000+
in 7.10.0.
8971001
8981002
*Impact* +
8991003
Use the {ref}/repositories-metering-apis.html[repositories metering APIs]

0 commit comments

Comments
 (0)