Skip to content

Commit 3ed3e19

Browse files
committed
Add aggregations external docs link and remove additionalProperties
1 parent 9d43ecc commit 3ed3e19

File tree

6 files changed

+28
-5
lines changed

6 files changed

+28
-5
lines changed

docs/overlays/elasticsearch-shared-overlays.yaml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1067,10 +1067,13 @@ actions:
10671067
externalDocs:
10681068
url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/collapse-search-results
10691069
- target: "$.components['schemas']['_global.search._types.SearchRequestBody'].properties"
1070-
description: Add x-model
1070+
description: Add x-model to SearchRequestBody aggregations property
10711071
update:
10721072
aggregations:
10731073
x-model: true
1074+
- target: "$.components['schemas']['_global.search._types.SearchRequestBody'].properties.aggregations.additionalProperties"
1075+
description: Remove additionalProperties from SearchRequestBody aggregations
1076+
remove: true
10741077
# Examples
10751078
## xCodeSamples
10761079
- target: "$.paths['/{index}/_doc/{id}']['head']"

output/openapi/elasticsearch-openapi.json

Lines changed: 6 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: 6 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 & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/_global/search/SearchRequest.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -387,7 +387,9 @@ export interface Request extends RequestBase {
387387
body: {
388388
/**
389389
* Defines the aggregations that are run as part of the search request.
390-
* @aliases aggs */ // ES uses "aggregations" in serialization
390+
* @aliases aggs
391+
* @ext_doc_id search-aggregations
392+
*/ // ES uses "aggregations" in serialization
391393
aggregations?: Dictionary<string, AggregationContainer>
392394
/**
393395
* Collapses search results the values of the specified field.

specification/_global/search/_types/SearchRequestBody.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,9 @@ import { Sort, SortResults } from '@_types/sort'
4242
export class SearchRequestBody {
4343
/**
4444
* Defines the aggregations that are run as part of the search request.
45-
* @aliases aggs */ // ES uses "aggregations" in serialization
45+
* @aliases aggs
46+
* @ext_doc_id search-aggregations
47+
*/ // ES uses "aggregations" in serialization
4648
aggregations?: Dictionary<string, AggregationContainer>
4749
/**
4850
* Collapses search results the values of the specified field.

0 commit comments

Comments
 (0)