Skip to content

Commit

Permalink
Update bulk descriptions. (#595)
Browse files Browse the repository at this point in the history
Signed-off-by: Archer <[email protected]>
  • Loading branch information
Naarcha-AWS authored Oct 1, 2024
1 parent 9771b03 commit 939a292
Showing 1 changed file with 10 additions and 11 deletions.
21 changes: 10 additions & 11 deletions spec/schemas/_core.bulk.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,20 +29,19 @@ components:
dynamic_templates:
description: |-
A map from the full name of fields to the name of dynamic templates.
Defaults to an empty map.
If a name matches a dynamic template, then that template will be applied regardless of other match predicates defined in the template.
If a field is already defined in the mapping, then this parameter won't be used.
type: object
additionalProperties:
type: string
pipeline:
description: |-
ID of the pipeline to use to preprocess incoming documents.
If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.
If a final pipeline is configured it will always run, regardless of the value of this parameter.
The pipeline ID for preprocessing documents.
When the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.
When a final pipeline is configured, that pipeline will always run, regardless of the value of this parameter.
type: string
require_alias:
description: If `true`, the request's actions must target an index alias.
description: When `true`, require that all actions target an index alias rather than an index. Default is `false`.
type: boolean
OperationBase:
type: object
Expand All @@ -69,7 +68,7 @@ components:
- type: object
properties:
require_alias:
description: If `true`, the request's actions must target an index alias.
description: When `true`, the request's actions must target an index alias.
type: boolean
retry_on_conflict:
type: number
Expand All @@ -80,19 +79,19 @@ components:
properties:
detect_noop:
description: |-
Set to false to disable setting 'result' in the response
When `false` disables the setting 'result' in the response
to 'noop' if no change to the document occurred.
type: boolean
doc:
description: A partial update to an existing document.
type: object
doc_as_upsert:
description: Set to true to use the contents of 'doc' as the value of 'upsert'
description: When `true`, uses the contents of 'doc' as the value of 'upsert'.
type: boolean
script:
$ref: '_common.yaml#/components/schemas/Script'
scripted_upsert:
description: Set to true to execute the script whether or not the document exists.
description: When `true`, executes the script whether or not the document exists.
type: boolean
_source:
$ref: '_core.search.yaml#/components/schemas/SourceConfig'
Expand All @@ -113,8 +112,8 @@ components:
type: ['null', string]
_index:
description: |-
Name of the index associated with the operation.
If the operation targeted a data stream, this is the backing index into which the document was written.
The name of the index associated with the operation.
If the operation targets a data stream, this is the backing index into which the document was written.
type: string
status:
description: HTTP status code returned for the operation.
Expand Down

0 comments on commit 939a292

Please sign in to comment.