Skip to content

Commit ea02113

Browse files
authored
[DOCS] Switch xrefs to external links (#83590) (#83592)
We reuse our breaking changes in the [Elastic Installation and Upgrade Guide](https://www.elastic.co/guide/en/elastic-stack/current/index.html). To prevent broken links, we have to use external links rather than xrefs inside breaking changes. Relates to #83487. (cherry picked from commit 02ea65a)
1 parent 5241766 commit ea02113

File tree

1 file changed

+37
-28
lines changed

1 file changed

+37
-28
lines changed

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

Lines changed: 37 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,10 @@ Use the replacement REST API endpoints. Requests submitted to the `_xpack`
2020
API endpoints will return an error.
2121
2222
*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.
2627
====
2728

2829
[[remove-mapping-type-api-endpoints]]
@@ -168,9 +169,12 @@ Update your application to use typeless REST API endpoints. Requests to
168169
endpoints that contain a mapping type will return an error.
169170
170171
*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`.
174178
175179
====
176180

@@ -227,8 +231,9 @@ Discontinue use of the `_term` order key. Requests that include a `_term` order
227231
key will return an error.
228232
229233
*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.
232237
====
233238

234239
[[remove-time-order-key]]
@@ -244,8 +249,9 @@ Discontinue use of the `_time` order key. Requests that include a `_time` order
244249
key will return an error.
245250
246251
*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.
249255
====
250256

251257
[[remove-moving-avg-agg]]
@@ -300,8 +306,9 @@ please use the more specific `fixed_interval` or `calendar_interval`
300306
parameters.
301307
302308
*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.
305312
====
306313

307314
[[ngram-edgengram-filter-names-removed]]
@@ -464,9 +471,9 @@ Use the {ref}/indices-templates-v1.html[create or update index template API]'s
464471
return an error.
465472
466473
*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`.
470477
====
471478

472479
.Synced flush has been removed.
@@ -481,8 +488,9 @@ Use the {ref}/indices-flush.html[flush API]. Requests to the
481488
`/<index>/flush/synced` or `/flush/synced` endpoints will return an error.
482489
483490
*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.
486494
====
487495

488496
.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
514522
parameter will return an error.
515523
516524
*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.
519528
====
520529

521530
.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
545554
include the parameter will return an error.
546555
547556
*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.
551560
====
552561

553562
.Reindex from remote now re-encodes URL-encoded index names.
@@ -583,9 +592,9 @@ Use the replacement parameters. Requests containing the `size` parameter will
583592
return an error.
584593
585594
*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.
589598
====
590599

591600
.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
926935
containing this parameter will return an error.
927936
928937
*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.
932941
====
933942

934943
.The search API's `from` request body and url parameter cannot be negative.

0 commit comments

Comments
 (0)