Skip to content

Commit 939a292

Browse files
authored
Update bulk descriptions. (#595)
Signed-off-by: Archer <[email protected]>
1 parent 9771b03 commit 939a292

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

spec/schemas/_core.bulk.yaml

+10-11
Original file line numberDiff line numberDiff line change
@@ -29,20 +29,19 @@ components:
2929
dynamic_templates:
3030
description: |-
3131
A map from the full name of fields to the name of dynamic templates.
32-
Defaults to an empty map.
3332
If a name matches a dynamic template, then that template will be applied regardless of other match predicates defined in the template.
3433
If a field is already defined in the mapping, then this parameter won't be used.
3534
type: object
3635
additionalProperties:
3736
type: string
3837
pipeline:
3938
description: |-
40-
ID of the pipeline to use to preprocess incoming documents.
41-
If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.
42-
If a final pipeline is configured it will always run, regardless of the value of this parameter.
39+
The pipeline ID for preprocessing documents.
40+
When the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.
41+
When a final pipeline is configured, that pipeline will always run, regardless of the value of this parameter.
4342
type: string
4443
require_alias:
45-
description: If `true`, the request's actions must target an index alias.
44+
description: When `true`, require that all actions target an index alias rather than an index. Default is `false`.
4645
type: boolean
4746
OperationBase:
4847
type: object
@@ -69,7 +68,7 @@ components:
6968
- type: object
7069
properties:
7170
require_alias:
72-
description: If `true`, the request's actions must target an index alias.
71+
description: When `true`, the request's actions must target an index alias.
7372
type: boolean
7473
retry_on_conflict:
7574
type: number
@@ -80,19 +79,19 @@ components:
8079
properties:
8180
detect_noop:
8281
description: |-
83-
Set to false to disable setting 'result' in the response
82+
When `false` disables the setting 'result' in the response
8483
to 'noop' if no change to the document occurred.
8584
type: boolean
8685
doc:
8786
description: A partial update to an existing document.
8887
type: object
8988
doc_as_upsert:
90-
description: Set to true to use the contents of 'doc' as the value of 'upsert'
89+
description: When `true`, uses the contents of 'doc' as the value of 'upsert'.
9190
type: boolean
9291
script:
9392
$ref: '_common.yaml#/components/schemas/Script'
9493
scripted_upsert:
95-
description: Set to true to execute the script whether or not the document exists.
94+
description: When `true`, executes the script whether or not the document exists.
9695
type: boolean
9796
_source:
9897
$ref: '_core.search.yaml#/components/schemas/SourceConfig'
@@ -113,8 +112,8 @@ components:
113112
type: ['null', string]
114113
_index:
115114
description: |-
116-
Name of the index associated with the operation.
117-
If the operation targeted a data stream, this is the backing index into which the document was written.
115+
The name of the index associated with the operation.
116+
If the operation targets a data stream, this is the backing index into which the document was written.
118117
type: string
119118
status:
120119
description: HTTP status code returned for the operation.

0 commit comments

Comments
 (0)