You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/reference/migration/migrate_8_0/rest-api-changes.asciidoc
+37-28Lines changed: 37 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,9 +20,10 @@ Use the replacement REST API endpoints. Requests submitted to the `_xpack`
20
20
API endpoints will return an error.
21
21
22
22
*Compatibility* +
23
-
When <<rest-api-compatibility>> is <<request-rest-api-compatibility,requested>>,
24
-
any requests that include the`_xpack` prefix are rerouted to the corresponding
25
-
URL without the `_xpack` prefix.
23
+
When {ref}/rest-api-compatibility.html[rest-api-compatibility] is
24
+
{ref}/rest-api-compatibility.html[requested], any requests that include
25
+
the`_xpack` prefix are rerouted to the corresponding URL without the `_xpack`
26
+
prefix.
26
27
====
27
28
28
29
[[remove-mapping-type-api-endpoints]]
@@ -168,9 +169,12 @@ Update your application to use typeless REST API endpoints. Requests to
168
169
endpoints that contain a mapping type will return an error.
169
170
170
171
*Compatibility* +
171
-
When <<rest-api-compatibility>> is <<request-rest-api-compatibility,requested>>, if a request includes a custom mapping type it is ignored. The request is rerouted to the corresponding typeless URL.
172
-
Custom mapping types in request bodies and type related HTTP
173
-
parameters are ignored, and responses, where warranted, include `_type` : `_doc`.
172
+
When {ref}/rest-api-compatibility.html[rest-api-compatibility] is
173
+
{ref}/rest-api-compatibility.html[requested], if a request includes a custom
174
+
mapping type it is ignored. The request is rerouted to the corresponding
175
+
typeless URL. Custom mapping types in request bodies and type related HTTP
176
+
parameters are ignored, and responses, where warranted, include `_type` :
177
+
`_doc`.
174
178
175
179
====
176
180
@@ -227,8 +231,9 @@ Discontinue use of the `_term` order key. Requests that include a `_term` order
227
231
key will return an error.
228
232
229
233
*Compatibility* +
230
-
When <<rest-api-compatibility>> is <<request-rest-api-compatibility,requested>>,
231
-
the `_term` order is ignored and `key` is used instead.
234
+
When {ref}/rest-api-compatibility.html[rest-api-compatibility] is
235
+
{ref}/rest-api-compatibility.html[requested], the `_term` order is ignored and
236
+
`key` is used instead.
232
237
====
233
238
234
239
[[remove-time-order-key]]
@@ -244,8 +249,9 @@ Discontinue use of the `_time` order key. Requests that include a `_time` order
244
249
key will return an error.
245
250
246
251
*Compatibility* +
247
-
When <<rest-api-compatibility>> is <<request-rest-api-compatibility,requested>>,
248
-
the `_time` order is ignored and `_key` is used instead.
252
+
When {ref}/rest-api-compatibility.html[rest-api-compatibility] is
253
+
{ref}/rest-api-compatibility.html[requested], the `_time` order is ignored and
254
+
`_key` is used instead.
249
255
====
250
256
251
257
[[remove-moving-avg-agg]]
@@ -300,8 +306,9 @@ please use the more specific `fixed_interval` or `calendar_interval`
300
306
parameters.
301
307
302
308
*Compatibility* +
303
-
When <<rest-api-compatibility>> is <<request-rest-api-compatibility,requested>>,
304
-
the `interval` parameter is adapted to either a fixed or calendar interval.
309
+
When {ref}/rest-api-compatibility.html[rest-api-compatibility] is
310
+
{ref}/rest-api-compatibility.html[requested], the `interval` parameter is
311
+
adapted to either a fixed or calendar interval.
305
312
====
306
313
307
314
[[ngram-edgengram-filter-names-removed]]
@@ -464,9 +471,9 @@ Use the {ref}/indices-templates-v1.html[create or update index template API]'s
464
471
return an error.
465
472
466
473
*Compatibility* +
467
-
When <<rest-api-compatibility>> is <<request-rest-api-compatibility,requested>>,
468
-
the `template` parameter is mapped to `index_patterns`.
469
-
474
+
When {ref}/rest-api-compatibility.html[rest-api-compatibility] is
475
+
{ref}/rest-api-compatibility.html[requested], the `template` parameter is mapped
476
+
to `index_patterns`.
470
477
====
471
478
472
479
.Synced flush has been removed.
@@ -481,8 +488,9 @@ Use the {ref}/indices-flush.html[flush API]. Requests to the
481
488
`/<index>/flush/synced` or `/flush/synced` endpoints will return an error.
482
489
483
490
*Compatibility* +
484
-
When <<rest-api-compatibility>> is <<request-rest-api-compatibility,requested>>,
485
-
the request to synced flush is routed to the equivalent non-synced flush URL.
491
+
When {ref}/rest-api-compatibility.html[rest-api-compatibility] is
492
+
{ref}/rest-api-compatibility.html[requested], the request to synced flush is
493
+
routed to the equivalent non-synced flush URL.
486
494
====
487
495
488
496
.The default for the `?wait_for_active_shards` parameter on the close index API has changed.
@@ -514,8 +522,9 @@ Discontinue use of the `types` query parameter. Requests that include the
514
522
parameter will return an error.
515
523
516
524
*Compatibility* +
517
-
When <<rest-api-compatibility>> is <<request-rest-api-compatibility,requested>>,
518
-
the `types` query parameter is ignored and stats are returned for the entire index.
525
+
When {ref}/rest-api-compatibility.html[rest-api-compatibility] is
526
+
{ref}/rest-api-compatibility.html[requested], the `types` query parameter is
527
+
ignored and stats are returned for the entire index.
519
528
====
520
529
521
530
.The `user_agent` ingest processor's `ecs` parameter has no effect.
@@ -545,9 +554,9 @@ Discontinue use of the `include_type_name` query parameter. Requests that
545
554
include the parameter will return an error.
546
555
547
556
*Compatibility* +
548
-
When <<rest-api-compatibility>> is <<request-rest-api-compatibility,requested>>,
549
-
the `include_type_name` query parameter is ignored and any custom mapping types
550
-
in the request are removed.
557
+
When {ref}/rest-api-compatibility.html[rest-api-compatibility] is
558
+
{ref}/rest-api-compatibility.html[requested], the `include_type_name` query
559
+
parameter is ignored and any custom mapping types in the request are removed.
551
560
====
552
561
553
562
.Reindex from remote now re-encodes URL-encoded index names.
@@ -583,9 +592,9 @@ Use the replacement parameters. Requests containing the `size` parameter will
583
592
return an error.
584
593
585
594
*Compatibility* +
586
-
When <<rest-api-compatibility>> is <<request-rest-api-compatibility,requested>>,
587
-
the `size` parameter is mapped to the `max_docs` parameter.
588
-
595
+
When {ref}/rest-api-compatibility.html[rest-api-compatibility] is
596
+
{ref}/rest-api-compatibility.html[requested], the `size` parameter is mapped to
597
+
the `max_docs` parameter.
589
598
====
590
599
591
600
.The update by query API now rejects unsupported `script` fields.
@@ -926,9 +935,9 @@ Discontinue use of the `use_field_mapping` request body parameter. Requests
926
935
containing this parameter will return an error.
927
936
928
937
*Compatibility* +
929
-
When <<rest-api-compatibility>> is <<request-rest-api-compatibility,requested>>,
930
-
the `use_field_mapping` parameter is ignored.
931
-
938
+
When {ref}/rest-api-compatibility.html[rest-api-compatibility] is
939
+
{ref}/rest-api-compatibility.html[requested], the `use_field_mapping` parameter
940
+
is ignored.
932
941
====
933
942
934
943
.The search API's `from` request body and url parameter cannot be negative.
0 commit comments