Skip to content

Commit b02a111

Browse files
committed
[OpenAPI] Add x-model to specialized queries (#3023)
1 parent 16028e6 commit b02a111

28 files changed

+1287
-198
lines changed

docs/overlays/elasticsearch-shared-overlays.yaml

Lines changed: 734 additions & 17 deletions
Large diffs are not rendered by default.

specification/_doc_ids/table.csv

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -359,6 +359,7 @@ query-dsl-function-score-query,https://www.elastic.co/guide/en/elasticsearch/ref
359359
query-dsl-fuzzy-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-fuzzy-query.html
360360
query-dsl-geo-bounding-box-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-geo-bounding-box-query.html
361361
query-dsl-geo-distance-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-geo-distance-query.html
362+
query-dsl-geo-polygon-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-geo-polygon-query.html
362363
query-dsl-geo-shape-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-geo-shape-query.html
363364
query-dsl-has-child-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-has-child-query.html
364365
query-dsl-has-parent-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-has-parent-query.html
@@ -374,7 +375,6 @@ query-dsl-match-query,https://www.elastic.co/guide/en/elasticsearch/reference/{b
374375
query-dsl-minimum-should-match,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-minimum-should-match.html
375376
query-dsl-minimum-should-match,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-minimum-should-match.html
376377
query-dsl-mlt-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-mlt-query.html
377-
query-dsl-mlt-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-mlt-query.html
378378
query-dsl-multi-match-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-multi-match-query.html
379379
query-dsl-multi-term-rewrite,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-multi-term-rewrite.html
380380
query-dsl-nested-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-nested-query.html
@@ -386,11 +386,12 @@ query-dsl-query-string-query,https://www.elastic.co/guide/en/elasticsearch/refer
386386
query-dsl-range-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-range-query.html
387387
query-dsl-rank-feature-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-rank-feature-query.html
388388
query-dsl-regexp-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-regexp-query.html
389+
query-dsl-rule-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-rule-query.html
389390
query-dsl-script-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-script-query.html
390391
query-dsl-script-score-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-script-score-query.html
392+
query-dsl-semantic-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-semantic-query.html
391393
query-dsl-shape-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-shape-query.html
392394
query-dsl-simple-query-string-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-simple-query-string-query.html
393-
query-dsl-simple-query-string-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-simple-query-string-query.html
394395
query-dsl-span-containing-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-containing-query.html
395396
query-dsl-span-field-masking-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-field-masking-query.html
396397
query-dsl-span-first-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-span-first-query.html
@@ -404,6 +405,7 @@ query-dsl-term-query,https://www.elastic.co/guide/en/elasticsearch/reference/{br
404405
query-dsl-terms-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-terms-query.html
405406
query-dsl-terms-set-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-terms-set-query.html
406407
query-dsl-text-expansion-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-text-expansion-query.html
408+
query-dsl-weighted-tokens-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-weighted-tokens-query.html
407409
query-dsl-wildcard-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-wildcard-query.html
408410
query-dsl-wrapper-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-wrapper-query.html
409411
query-dsl,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl.html
@@ -429,6 +431,7 @@ run-as-privilege,https://www.elastic.co/guide/en/elasticsearch/reference/{branch
429431
runtime-search-request,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/runtime-search-request.html
430432
script-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/script-processor.html
431433
scroll-search-results,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/paginate-search-results.html#scroll-search-results
434+
search-aggregations,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations.html
432435
search-aggregations-bucket-adjacency-matrix-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-adjacency-matrix-aggregation.html
433436
search-aggregations-bucket-autodatehistogram-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-autodatehistogram-aggregation.html
434437
search-aggregations-bucket-categorize-text-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-categorize-text-aggregation.html
@@ -450,6 +453,7 @@ search-aggregations-pipeline-bucket-path,https://www.elastic.co/guide/en/elastic
450453
search-aggregations-pipeline-bucket-script-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-bucket-script-aggregation.html
451454
search-aggregations-pipeline-bucket-selector-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-bucket-selector-aggregation.html
452455
search-aggregations-pipeline-bucket-sort-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-bucket-sort-aggregation.html
456+
search-aggregations-bucket-composite-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-bucket-composite-aggregation.html
453457
search-aggregations-pipeline-cumulative-cardinality-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-cumulative-cardinality-aggregation.html
454458
search-aggregations-pipeline-cumulative-sum-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-cumulative-sum-aggregation.html
455459
search-aggregations-pipeline-derivative-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-aggregations-pipeline-derivative-aggregation.html
@@ -584,6 +588,7 @@ slm-api-stop,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sl
584588
sort-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sort-processor.html
585589
sort-search-results,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sort-search-results.html
586590
sort-tiebreaker,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql.html#eql-search-specify-a-sort-tiebreaker
591+
query-dsl-sparse-vector-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-sparse-vector-query.html
587592
split-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/split-processor.html
588593
sql-rest-filtering,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sql-rest-filtering.html
589594
sql-rest-format,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sql-rest-format.html

specification/_global/knn_search/KnnSearchRequest.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,10 @@ export interface Request extends RequestBase {
7474
* @availability serverless
7575
*/
7676
filter?: QueryContainer | QueryContainer[]
77-
/** kNN query to execute */
77+
/**
78+
* kNN query to execute
79+
* @ext_doc_id query-dsl-knn-query
80+
*/
7881
knn: Query
7982
}
8083
}

specification/_types/Knn.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,9 @@ export interface KnnSearch {
5151
inner_hits?: InnerHits
5252
}
5353

54+
/**
55+
* @ext_doc_id query-dsl-knn-query
56+
*/
5457
export interface KnnQuery extends QueryBase {
5558
/** The name of the vector field to search against */
5659
field: Field

0 commit comments

Comments
 (0)