Skip to content

Commit e545dd0

Browse files
committed
Add overlay for query in graph explore API
1 parent 576c5df commit e545dd0

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

docs/overlays/elasticsearch-shared-overlays.yaml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,28 @@ actions:
131131
externalDocs:
132132
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
133133
description: Query DSL
134+
- target: "$.components['requestBodies']['graph.explore'].content['application/json'].schema.properties.query"
135+
description: Remove query object from graph explore operation
136+
- target: "$.components['requestBodies']['graph.explore'].content['application/json'].schema.properties"
137+
description: "Re-add simplified query object in graph explore operation"
138+
update:
139+
query:
140+
x-abbreviated: true
141+
type: object
142+
description: >
143+
A seed query that identifies the documents of interest.
144+
Can be any valid Elasticsearch query.
145+
- target: "$.components['schemas']['graph._types:Hop'].properties.query"
146+
description: Remove query object from graph explore connections schema
147+
- target: "$.components['schemas']['graph._types:Hop'].properties"
148+
description: "Re-add simplified query object in graph explore connections schema"
149+
update:
150+
query:
151+
x-abbreviated: true
152+
type: object
153+
description: >
154+
An optional guiding query that constrains the Graph API as it explores connected terms.
155+
For example, you might want to direct the Graph API to ignore older data by specifying a query that identifies recent documents.
134156
# Examples
135157
- target: "$.components['requestBodies']['async_search.submit']"
136158
description: "Add example for asynch search submit request"

0 commit comments

Comments
 (0)