Skip to content

Commit 2c28eaf

Browse files
committed
Add overlay for query in async search and search API
1 parent cd0d063 commit 2c28eaf

File tree

1 file changed

+47
-7
lines changed

1 file changed

+47
-7
lines changed

docs/overlays/elasticsearch-shared-overlays.yaml

Lines changed: 47 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,8 @@ actions:
4848
- target: "$.components['schemas']['ml._types:Datafeed'].properties.query"
4949
description: Remove query object from anomaly detection datafeed
5050
remove: true
51-
- target: "$.components['schemas']['ml._types:DatafeedConfig'].properties.query"
52-
description: Remove query object from anomaly detection datafeed configuration
53-
remove: true
54-
- target: "$.components['schemas']['ml._types:DatafeedConfig'].properties"
55-
description: Re-add a simplified query object in anomaly detection datafeed configuration
51+
- target: "$.components['schemas']['ml._types:Datafeed'].properties"
52+
description: Re-add a simplified query object in anomaly detection datafeed
5653
update:
5754
query:
5855
x-abbreviated: true
@@ -65,8 +62,11 @@ actions:
6562
externalDocs:
6663
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
6764
description: Query DSL
68-
- target: "$.components['schemas']['ml._types:Datafeed'].properties"
69-
description: Re-add a simplified query object in anomaly detection datafeed
65+
- target: "$.components['schemas']['ml._types:DatafeedConfig'].properties.query"
66+
description: Remove query object from anomaly detection datafeed configuration
67+
remove: true
68+
- target: "$.components['schemas']['ml._types:DatafeedConfig'].properties"
69+
description: Re-add a simplified query object in anomaly detection datafeed configuration
7070
update:
7171
query:
7272
x-abbreviated: true
@@ -133,6 +133,7 @@ actions:
133133
description: Query DSL
134134
- target: "$.components['requestBodies']['graph.explore'].content['application/json'].schema.properties.query"
135135
description: Remove query object from graph explore operation
136+
remove: true
136137
- target: "$.components['requestBodies']['graph.explore'].content['application/json'].schema.properties"
137138
description: "Re-add simplified query object in graph explore operation"
138139
update:
@@ -142,8 +143,12 @@ actions:
142143
description: >
143144
A seed query that identifies the documents of interest.
144145
Can be any valid Elasticsearch query.
146+
externalDocs:
147+
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
148+
description: Query DSL
145149
- target: "$.components['schemas']['graph._types:Hop'].properties.query"
146150
description: Remove query object from graph explore connections schema
151+
remove: true
147152
- target: "$.components['schemas']['graph._types:Hop'].properties"
148153
description: "Re-add simplified query object in graph explore connections schema"
149154
update:
@@ -153,8 +158,12 @@ actions:
153158
description: >
154159
An optional guiding query that constrains the Graph API as it explores connected terms.
155160
For example, you might want to direct the Graph API to ignore older data by specifying a query that identifies recent documents.
161+
externalDocs:
162+
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
163+
description: Query DSL
156164
- target: "$.components['schemas']['_global.scripts_painless_execute:PainlessContextSetup'].properties.query"
157165
description: Remove query object from painless script context setup schema
166+
remove: true
158167
- target: "$.components['schemas']['_global.scripts_painless_execute:PainlessContextSetup'].properties"
159168
description: "Re-add simplified query object in painless script context setup schema"
160169
update:
@@ -165,6 +174,37 @@ actions:
165174
This property applies only when `score` is specified as the script `context`.
166175
Use this property to specify a query for computing a score.
167176
Besides deciding whether or not the document matches, the query clause also calculates a relevance score in the `_score` metadata field.
177+
externalDocs:
178+
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
179+
description: Query DSL
180+
- target: "$.components['requestBodies']['async_search.submit'].content['application/json'].schema.properties.query"
181+
description: Remove query object from asynch search request
182+
remove: true
183+
- target: "$.components['requestBodies']['async_search.submit'].content['application/json'].schema.properties"
184+
description: "Re-add simplified query object in asynch search request"
185+
update:
186+
query:
187+
x-abbreviated: true
188+
type: object
189+
description: >
190+
Defines the search definition using the Query DSL.
191+
externalDocs:
192+
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
193+
description: Query DSL
194+
- target: "$.components['requestBodies']['search'].content['application/json'].schema.properties.query"
195+
description: Remove query object from search request
196+
remove: true
197+
- target: "$.components['requestBodies']['search'].content['application/json'].schema.properties"
198+
description: "Re-add simplified query object in search request"
199+
update:
200+
query:
201+
x-abbreviated: true
202+
type: object
203+
description: >
204+
Defines the search definition using the Query DSL.
205+
externalDocs:
206+
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
207+
description: Query DSL
168208
# Examples
169209
- target: "$.components['requestBodies']['async_search.submit']"
170210
description: "Add example for asynch search submit request"

0 commit comments

Comments
 (0)