@@ -29,20 +29,19 @@ components:
29
29
dynamic_templates :
30
30
description : |-
31
31
A map from the full name of fields to the name of dynamic templates.
32
- Defaults to an empty map.
33
32
If a name matches a dynamic template, then that template will be applied regardless of other match predicates defined in the template.
34
33
If a field is already defined in the mapping, then this parameter won't be used.
35
34
type : object
36
35
additionalProperties :
37
36
type : string
38
37
pipeline :
39
38
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.
43
42
type : string
44
43
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` .
46
45
type : boolean
47
46
OperationBase :
48
47
type : object
@@ -69,7 +68,7 @@ components:
69
68
- type : object
70
69
properties :
71
70
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.
73
72
type : boolean
74
73
retry_on_conflict :
75
74
type : number
@@ -80,19 +79,19 @@ components:
80
79
properties :
81
80
detect_noop :
82
81
description : |-
83
- Set to false to disable setting 'result' in the response
82
+ When ` false` disables the setting 'result' in the response
84
83
to 'noop' if no change to the document occurred.
85
84
type : boolean
86
85
doc :
87
86
description : A partial update to an existing document.
88
87
type : object
89
88
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'.
91
90
type : boolean
92
91
script :
93
92
$ref : ' _common.yaml#/components/schemas/Script'
94
93
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.
96
95
type : boolean
97
96
_source :
98
97
$ref : ' _core.search.yaml#/components/schemas/SourceConfig'
@@ -113,8 +112,8 @@ components:
113
112
type : ['null', string]
114
113
_index :
115
114
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.
118
117
type : string
119
118
status :
120
119
description : HTTP status code returned for the operation.
0 commit comments