Skip to content

Commit 0a70715

Browse files
authored
[DOCS] Add require_alias to Bulk API (#66259) (#66265)
1 parent f6933b4 commit 0a70715

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

docs/reference/docs/bulk.asciidoc

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,11 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=pipeline]
211211

212212
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=refresh]
213213

214+
`require_alias`::
215+
(Optional, Boolean)
216+
If `true`, the request's actions must target an <<indices-aliases,index alias>>.
217+
Defaults to `false`.
218+
214219
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing]
215220

216221
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source]
@@ -237,6 +242,8 @@ The following line must contain the source data to be indexed.
237242
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-index]
238243

239244
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-id]
245+
246+
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-require-alias]
240247
--
241248

242249
`delete`::
@@ -249,6 +256,8 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-index]
249256
`_id`::
250257
(Required, string)
251258
The document ID.
259+
260+
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-require-alias]
252261
--
253262

254263
`index`::
@@ -261,6 +270,8 @@ The following line must contain the source data to be indexed.
261270
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-index]
262271

263272
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-id]
273+
274+
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-require-alias]
264275
--
265276

266277
`update`::
@@ -272,6 +283,8 @@ The following line must contain the partial document and update options.
272283
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-index]
273284

274285
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-id]
286+
287+
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-require-alias]
275288
--
276289

277290
`doc`::

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -602,6 +602,13 @@ such as `1264`.
602602
A value of `-1` indicates {es} was unable to compute this number.
603603
end::memory[]
604604

605+
tag::bulk-require-alias[]
606+
`require_alias`::
607+
(Optional, Boolean)
608+
If `true`, the action must target an <<indices-aliases,index alias>>. Defaults
609+
to `false`.
610+
end::bulk-require-alias[]
611+
605612
tag::require-alias[]
606613
`require_alias`::
607614
(Optional, Boolean)

0 commit comments

Comments
 (0)