Skip to content

Commit 704a574

Browse files
lcawlgithub-actions[bot]
authored andcommitted
[OpenAPI] Add more x-model and @ext_doc_id values (#3048)
(cherry picked from commit dad2aa1)
1 parent ad31274 commit 704a574

File tree

8 files changed

+38
-6
lines changed

8 files changed

+38
-6
lines changed

docs/overlays/elasticsearch-openapi-overlays.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,14 @@ actions:
99
update:
1010
title: Elasticsearch API
1111
description: >
12+
Elasticsearch provides REST APIs that are used by the UI components and can be called directly to configure and access Elasticsearch features.
13+
1214
## Documentation source and versions
1315
1416
This documentation is derived from the `8.x` branch of the [elasticsearch-specification](https://github.com/elastic/elasticsearch-specification) repository.
1517
It is provided under license [Attribution-NonCommercial-NoDerivatives 4.0 International](https://creativecommons.org/licenses/by-nc-nd/4.0/).
18+
19+
This documentation contains work-in-progress information for future Elastic Stack releases.
1620
x-doc-license:
1721
name: Attribution-NonCommercial-NoDerivatives 4.0 International
1822
url: 'https://creativecommons.org/licenses/by-nc-nd/4.0/'

docs/overlays/elasticsearch-shared-overlays.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1070,6 +1070,17 @@ actions:
10701070
externalDocs:
10711071
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
10721072
description: Query DSL
1073+
- target: "$.components['schemas']['_global.search._types:FieldCollapse']"
1074+
description: Add x-model and externalDocs
1075+
update:
1076+
x-model: true
1077+
externalDocs:
1078+
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
10731084
# Examples
10741085
- target: "$.components['requestBodies']['async_search.submit']"
10751086
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: 9 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/_doc_ids/table.csv

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ cluster,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster
8080
common-options,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/common-options.html
8181
community-id-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/community-id-processor.html
8282
connector-sync-job-cancel,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cancel-connector-sync-job-api.html
83+
collapse-search-results,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/collapse-search-results.html
8384
connector-sync-job-delete,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-connector-sync-job-api.html
8485
connector-sync-job-get,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-connector-sync-job-api.html
8586
connector-sync-job-post,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/create-connector-sync-job-api.html

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
/**

specification/_global/search/_types/FieldCollapse.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ import { Field } from '@_types/common'
2121
import { integer } from '@_types/Numeric'
2222
import { InnerHits } from './hits'
2323

24+
/**
25+
* @ext_doc_id collapse-search-results
26+
*/
2427
export class FieldCollapse {
2528
/**
2629
* The field to collapse the result set on

0 commit comments

Comments
 (0)