Skip to content

Fix rest-api-spec and docs for bulk API #118415

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 11, 2024
Merged

Fix rest-api-spec and docs for bulk API #118415

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/reference/docs/bulk.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,6 +257,10 @@ include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=refresh]
(Optional, Boolean) If `true`, the request's actions must target an index alias.
Defaults to `false`.

`require_data_stream`::
(Optional, Boolean) If `true`, the request's actions must target a data stream (existing or to-be-created).
Defaults to `false`.

include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=routing]

include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=source]
Expand Down
8 changes: 2 additions & 6 deletions rest-api-spec/src/main/resources/rest-api-spec/api/bulk.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,6 @@
"type":"time",
"description":"Explicit operation timeout"
},
"type":{
"type":"string",
"description":"Default document type for items which don't provide one"
},
"_source":{
"type":"list",
"description":"True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request"
Expand All @@ -78,11 +74,11 @@
},
"require_alias": {
"type": "boolean",
"description": "Sets require_alias for all incoming documents. Defaults to unset (false)"
"description": "If true, the request’s actions must target an index alias. Defaults to false."
},
"require_data_stream": {
"type": "boolean",
"description": "When true, requires the destination to be a data stream (existing or to-be-created). Default is false"
"description": "If true, the request's actions must target a data stream (existing or to-be-created). Default to false"
},
"list_executed_pipelines": {
"type": "boolean",
Expand Down
Loading