From 8dc3fa98f7772ec503986c9dffe77337a907839c Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Mon, 14 Dec 2020 10:57:17 -0500 Subject: [PATCH] [DOCS] Add `require_alias` to Bulk API (#66259) --- docs/reference/docs/bulk.asciidoc | 13 +++++++++++++ docs/reference/rest-api/common-parms.asciidoc | 7 +++++++ 2 files changed, 20 insertions(+) diff --git a/docs/reference/docs/bulk.asciidoc b/docs/reference/docs/bulk.asciidoc index d089d71f3395..acf777103997 100644 --- a/docs/reference/docs/bulk.asciidoc +++ b/docs/reference/docs/bulk.asciidoc @@ -211,6 +211,11 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=pipeline] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=refresh] +`require_alias`:: +(Optional, Boolean) +If `true`, the request's actions must target an <>. +Defaults to `false`. + include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=routing] 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. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-index] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-id] + +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-require-alias] -- `delete`:: @@ -249,6 +256,8 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-index] `_id`:: (Required, string) The document ID. + +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-require-alias] -- `index`:: @@ -261,6 +270,8 @@ The following line must contain the source data to be indexed. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-index] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-id] + +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-require-alias] -- `update`:: @@ -272,6 +283,8 @@ The following line must contain the partial document and update options. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-index] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-id] + +include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bulk-require-alias] -- `doc`:: diff --git a/docs/reference/rest-api/common-parms.asciidoc b/docs/reference/rest-api/common-parms.asciidoc index a09d5c98519a..9dca4dc19f7f 100644 --- a/docs/reference/rest-api/common-parms.asciidoc +++ b/docs/reference/rest-api/common-parms.asciidoc @@ -580,6 +580,13 @@ such as `1264`. A value of `-1` indicates {es} was unable to compute this number. end::memory[] +tag::bulk-require-alias[] +`require_alias`:: +(Optional, Boolean) +If `true`, the action must target an <>. Defaults +to `false`. +end::bulk-require-alias[] + tag::require-alias[] `require_alias`:: (Optional, Boolean)