Skip to content

Commit 6ac1723

Browse files
committed
[OpenAPI] Add more externalDocs and x-model values
1 parent e41e836 commit 6ac1723

File tree

5 files changed

+21
-5
lines changed

5 files changed

+21
-5
lines changed

docs/overlays/elasticsearch-shared-overlays.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1076,6 +1076,11 @@ actions:
10761076
x-model: true
10771077
externalDocs:
10781078
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/collapse-search-results.html
1079+
- target: "$.components['schemas']['_global.msearch:MultisearchBody'].properties"
1080+
description: Add x-model
1081+
update:
1082+
aggregations:
1083+
x-model: true
10791084
# Examples
10801085
- target: "$.components['requestBodies']['async_search.submit']"
10811086
description: "Add example for asynch search submit request"

output/openapi/elasticsearch-openapi.json

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/openapi/elasticsearch-serverless-openapi.json

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/schema.json

Lines changed: 6 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/_global/msearch/types.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,10 @@ export class MultisearchHeader {
6868

6969
// We should keep this in sync with the normal search request body.
7070
export class MultisearchBody {
71-
/** @aliases aggs */ // ES uses "aggregations" in serialization
71+
/**
72+
* @aliases aggs
73+
* @ext_doc_id search-aggregations
74+
*/ // ES uses "aggregations" in serialization
7275
aggregations?: Dictionary<string, AggregationContainer>
7376
collapse?: FieldCollapse
7477
/**

0 commit comments

Comments
 (0)