diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv index 3d4efeb86e..c4b5c02b04 100644 --- a/specification/_doc_ids/table.csv +++ b/specification/_doc_ids/table.csv @@ -153,6 +153,7 @@ connector-update-scheduling,https://www.elastic.co/docs/api/doc/elasticsearch/op connector-update-service-type,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-service-type,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-service-type-api.html, connector-update-status,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-status,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/update-connector-status-api.html, convert-processor,https://www.elastic.co/docs/reference/enrich-processor/convert-processor,, +create_index_from_source_index,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/create-index-from-source,, cron-expressions,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/api-conventions#api-cron-expressions,, csv-processor,https://www.elastic.co/docs/reference/enrich-processor/csv-processor,, dangling-index-delete,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-dangling-indices-delete-dangling-index,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/dangling-index-delete.html, @@ -234,14 +235,17 @@ esql-get-view,https://www.elastic.co/docs/api/doc/elasticsearch#TODO,, esql-put-view,https://www.elastic.co/docs/api/doc/elasticsearch#TODO,, esql-delete-view,https://www.elastic.co/docs/api/doc/elasticsearch#TODO,, evaluate-dfanalytics,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-evaluate-data-frame,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/evaluate-dfanalytics.html, +evaluate-ranked-search-results,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/search-rank-eval,, execute-enrich-policy-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-execute-policy,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/execute-enrich-policy-api.html, execute-watch,https://www.elastic.co/docs/explore-analyze/alerts-cases/watcher/execute-watch,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/watcher-api-execute-watch.html, expected-reciprocal,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rank-eval#_expected_reciprocal_rank_err,, explain-dfanalytics,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-explain-data-frame-analytics,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/explain-dfanalytics.html, +explain-lifecycle-state,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/explain-lifecycle,, fail-processor,https://www.elastic.co/docs/reference/enrich-processor/fail-processor,, features-reset,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-features-reset-features,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/reset-features-api.html, field-and-document-access-control,https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level,, field-usage-stats,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-field-usage-stats,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/field-usage-stats.html, +filter-search-results,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/filter-search-results,, find-field-structure,https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-text_structure,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/text-structure-apis.html, find-message-structure,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-text-structure-find-message-structure,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/find-message-structure.html, find-structure,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-text-structure-find-structure,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/find-structure.html, @@ -634,10 +638,12 @@ delete-query-ruleset-from-ui,https://www.elastic.co/docs/solutions/search/query- random_sample,https://www.elastic.co/docs/api/doc/elasticsearch/group/ingest-random-sampling,, realtime,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/docs-get.html, redact-processor,https://www.elastic.co/docs/reference/enrich-processor/redact-processor,, +refresh_an_index,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/refresh-parameter,, regexp-syntax,https://www.elastic.co/docs/reference/query-languages/query-dsl/regexp-syntax,, register-repository,https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/self-managed,, registered-domain-processor,https://www.elastic.co/docs/reference/enrich-processor/registered-domain-processor,, reindex-indices,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/reindex-indices,, +reindex_legacy_backing_indices,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/reindex-data-stream,, relevance-scores,https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl#relevance-scores,, remove-processor,https://www.elastic.co/docs/reference/enrich-processor/remove-processor,, remote-clusters-api-key,https://www.elastic.co/docs/deploy-manage/remote-clusters/remote-clusters-api-key,, @@ -655,6 +661,7 @@ repository-shared-fs,https://www.elastic.co/docs/deploy-manage/tools/snapshot-an repository-source-only,https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/source-only-repository,, reroute-processor,https://www.elastic.co/docs/reference/enrich-processor/reroute-processor,, render-search-template-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-render-search-template,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/render-search-template-api.html, +rescore-search-results,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/rescore-search-results,, reset-transform,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-reset-transform,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/reset-transform.html, restore-snapshot,https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/restore-snapshot,, retrieve-stored-fields,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-stored-fields, @@ -671,6 +678,7 @@ rollup-search-limitations,https://www.elastic.co/docs/manage-data/lifecycle/roll rollup-start-job,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-start-job,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/rollup-start-job.html, rollup-stop-job,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-stop-job,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/rollup-stop-job.html, routing,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get#get-routing,, +rrf,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/reciprocal-rank-fusion,, run-as-privilege,https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/submitting-requests-on-behalf-of-other-users,, runtime-search-request,https://www.elastic.co/docs/manage-data/data-store/mapping/define-runtime-fields-in-search-request,, schedule-now-transform,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-schedule-now-transform,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/schedule-now-transform.html, @@ -781,9 +789,12 @@ search-highlight,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/h search-knn,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-knn-search,, search-multi-search,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-msearch,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/search-multi-search.html, search-multi-search-template,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-msearch-template,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/multi-search-template.html, +search-multiple-indices,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/search-multiple-data-streams-indices,, +search-profile,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/search-profile,, search-rank-eval,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rank-eval,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/search-rank-eval.html, search-search,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/search-search.html, search-shards,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-shards,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/search-shards.html, +search-shard-routing,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/search-shard-routing,, search-template,https://www.elastic.co/docs/solutions/search/search-templates,, search-template-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-template,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/search-template-api.html, search-terms-enum,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-terms-enum,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/search-terms-enum.html, @@ -942,6 +953,7 @@ synonym-set-delete,https://www.elastic.co/docs/api/doc/elasticsearch/operation/o synonym-set-get,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-get-synonym,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/get-synonyms-set.html, synonym-set-list,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-get-synonym,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/get-synonyms-set.html, synonym-solr,https://www.elastic.co/docs/reference/text-analysis/analysis-synonym-graph-tokenfilter#_solr_format_2,, +suggester,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/search-suggesters,, supported-flags,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-simple-query-string-query#supported-flags,, tasks,https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/tasks.html, templating-role-query,https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level#templating-role-query,, diff --git a/specification/_global/bulk/BulkRequest.ts b/specification/_global/bulk/BulkRequest.ts index a2ffb6d19c..229867e055 100644 --- a/specification/_global/bulk/BulkRequest.ts +++ b/specification/_global/bulk/BulkRequest.ts @@ -200,6 +200,7 @@ export interface Request extends RequestBase { refresh?: Refresh /** * A custom value that is used to route operations to a specific shard. + * @ext_doc_id search-shard-routing */ routing?: Routing /** diff --git a/specification/_global/count/CountRequest.ts b/specification/_global/count/CountRequest.ts index ea75eb0a38..d25ba3434d 100644 --- a/specification/_global/count/CountRequest.ts +++ b/specification/_global/count/CountRequest.ts @@ -65,6 +65,7 @@ export interface Request extends RequestBase { * A comma-separated list of data streams, indices, and aliases to search. * It supports wildcards (`*`). * To search all data streams and indices, omit this parameter or use `*` or `_all`. + * @ext_doc_id search-multiple-indices */ index?: Indices } diff --git a/specification/_global/create/CreateRequest.ts b/specification/_global/create/CreateRequest.ts index 5c54674b79..bdbb04cded 100644 --- a/specification/_global/create/CreateRequest.ts +++ b/specification/_global/create/CreateRequest.ts @@ -164,6 +164,7 @@ export interface Request extends RequestBase { require_data_stream?: boolean /** * A custom value that is used to route operations to a specific shard. + * @ext_doc_id search-shard-routing */ routing?: Routing /** diff --git a/specification/_global/delete_by_query/DeleteByQueryRequest.ts b/specification/_global/delete_by_query/DeleteByQueryRequest.ts index 1e61e56a5c..dabbe31d8b 100644 --- a/specification/_global/delete_by_query/DeleteByQueryRequest.ts +++ b/specification/_global/delete_by_query/DeleteByQueryRequest.ts @@ -135,6 +135,7 @@ export interface Request extends RequestBase { * A comma-separated list of data streams, indices, and aliases to search. * It supports wildcards (`*`). * To search all data streams or indices, omit this parameter or use `*` or `_all`. + * @ext_doc_id search-multiple-indices */ index: Indices } @@ -219,6 +220,7 @@ export interface Request extends RequestBase { /** * If `true`, the request cache is used for this request. * Defaults to the index-level setting. + * @ext_doc_id shard-request-cache */ request_cache?: boolean /** diff --git a/specification/_global/exists/DocumentExistsRequest.ts b/specification/_global/exists/DocumentExistsRequest.ts index a9b5ac37cd..7ed250b850 100644 --- a/specification/_global/exists/DocumentExistsRequest.ts +++ b/specification/_global/exists/DocumentExistsRequest.ts @@ -123,6 +123,7 @@ export interface Request extends RequestBase { * A comma-separated list of stored fields to return as part of a hit. * If no fields are specified, no stored fields are included in the response. * If this field is specified, the `_source` parameter defaults to `false`. + * @ext_doc_id retrieve-stored-fields */ stored_fields?: Fields /** diff --git a/specification/_global/index/IndexRequest.ts b/specification/_global/index/IndexRequest.ts index 353310a9d3..1c2336592c 100644 --- a/specification/_global/index/IndexRequest.ts +++ b/specification/_global/index/IndexRequest.ts @@ -230,6 +230,7 @@ export interface Request extends RequestBase { refresh?: Refresh /** * A custom value that is used to route operations to a specific shard. + * @ext_doc_id search-shard-routing */ routing?: Routing /** diff --git a/specification/_global/msearch_template/MultiSearchTemplateRequest.ts b/specification/_global/msearch_template/MultiSearchTemplateRequest.ts index 94f221d8c6..efe478954d 100644 --- a/specification/_global/msearch_template/MultiSearchTemplateRequest.ts +++ b/specification/_global/msearch_template/MultiSearchTemplateRequest.ts @@ -62,6 +62,7 @@ export interface Request extends RequestBase { * A comma-separated list of data streams, indices, and aliases to search. * It supports wildcards (`*`). * To search all data streams and indices, omit this parameter or use `*`. + * @ext_doc_id search-multiple-indices */ index?: Indices } diff --git a/specification/_global/open_point_in_time/OpenPointInTimeRequest.ts b/specification/_global/open_point_in_time/OpenPointInTimeRequest.ts index 721396a6ff..8a309da0c8 100644 --- a/specification/_global/open_point_in_time/OpenPointInTimeRequest.ts +++ b/specification/_global/open_point_in_time/OpenPointInTimeRequest.ts @@ -107,6 +107,7 @@ export interface Request extends RequestBase { preference?: string /** * A custom value that is used to route operations to a specific shard. + * @ext_doc_id search-shard-routing */ routing?: Routing /** diff --git a/specification/_global/rank_eval/RankEvalRequest.ts b/specification/_global/rank_eval/RankEvalRequest.ts index 166ec89d1d..b1e4883fec 100644 --- a/specification/_global/rank_eval/RankEvalRequest.ts +++ b/specification/_global/rank_eval/RankEvalRequest.ts @@ -31,6 +31,7 @@ import { RankEvalMetric, RankEvalRequestItem } from './types' * @index_privileges read * @doc_tag search * @doc_id search-rank-eval + * @ext_doc_id evaluate-ranked-search-results */ export interface Request extends RequestBase { urls: [ diff --git a/specification/_global/search/SearchRequest.ts b/specification/_global/search/SearchRequest.ts index 1a6c9e6572..b3900054d4 100644 --- a/specification/_global/search/SearchRequest.ts +++ b/specification/_global/search/SearchRequest.ts @@ -96,6 +96,7 @@ export interface Request extends RequestBase { * A comma-separated list of data streams, indices, and aliases to search. * It supports wildcards (`*`). * To search all data streams and indices, omit this parameter or use `*` or `_all`. + * @ext_doc_id search-multiple-indices */ index?: Indices } @@ -231,6 +232,7 @@ export interface Request extends RequestBase { request_cache?: boolean /** * A custom value that is used to route operations to a specific shard. + * @ext_doc_id search-shard-routing */ routing?: Routing /** @@ -469,12 +471,14 @@ export interface Request extends RequestBase { * Use the `post_filter` parameter to filter search results. * The search hits are filtered after the aggregations are calculated. * A post filter has no impact on the aggregation results. + * @ext_doc_id filter-search-results */ post_filter?: QueryContainer /** * Set to `true` to return detailed timing information about the execution of individual components in a search request. * NOTE: This is a debugging tool and adds significant overhead to search execution. * @server_default false + * @ext_doc_id search-profile */ profile?: boolean /** @@ -484,6 +488,7 @@ export interface Request extends RequestBase { query?: QueryContainer /** * Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases. + * @ext_doc_id rescore-search-results */ rescore?: Rescore | Rescore[] /** @@ -500,6 +505,7 @@ export interface Request extends RequestBase { script_fields?: Dictionary /** * Used to retrieve the next page of hits using a set of sort values from the previous page. + * @ext_doc_id search-after */ search_after?: SortResults /** @@ -511,6 +517,7 @@ export interface Request extends RequestBase { size?: integer /** * Split a scrolled search into multiple slices that can be consumed independently. + * @ext_doc_id slice-scroll */ slice?: SlicedScroll /** @@ -533,6 +540,7 @@ export interface Request extends RequestBase { fields?: Array /** * Defines a suggester that provides similar looking terms based on a provided text. + * @ext_doc_id suggester */ suggest?: Suggester /** diff --git a/specification/_global/search/_types/SearchRequestBody.ts b/specification/_global/search/_types/SearchRequestBody.ts index e23d59a8ff..a644e11bf8 100644 --- a/specification/_global/search/_types/SearchRequestBody.ts +++ b/specification/_global/search/_types/SearchRequestBody.ts @@ -113,12 +113,14 @@ export class SearchRequestBody { * Use the `post_filter` parameter to filter search results. * The search hits are filtered after the aggregations are calculated. * A post filter has no impact on the aggregation results. + * @ext_doc_id filter-search-results */ post_filter?: QueryContainer /** * Set to `true` to return detailed timing information about the execution of individual components in a search request. * NOTE: This is a debugging tool and adds significant overhead to search execution. * @server_default false + * @ext_doc_id search-profile */ profile?: boolean /** @@ -128,6 +130,7 @@ export class SearchRequestBody { query?: QueryContainer /** * Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases. + * @ext_doc_id rescore-search-results */ rescore?: Rescore | Rescore[] /** @@ -144,6 +147,7 @@ export class SearchRequestBody { script_fields?: Dictionary /** * Used to retrieve the next page of hits using a set of sort values from the previous page. + * @ext_doc_id search-after */ search_after?: SortResults /** @@ -155,6 +159,7 @@ export class SearchRequestBody { size?: integer /** * Split a scrolled search into multiple slices that can be consumed independently. + * @ext_doc_id slice-scroll */ slice?: SlicedScroll /** @@ -177,6 +182,7 @@ export class SearchRequestBody { fields?: Array /** * Defines a suggester that provides similar looking terms based on a provided text. + * @ext_doc_id suggester */ suggest?: Suggester /** diff --git a/specification/_global/search_shards/SearchShardsRequest.ts b/specification/_global/search_shards/SearchShardsRequest.ts index 36cb89c99a..ba25edde46 100644 --- a/specification/_global/search_shards/SearchShardsRequest.ts +++ b/specification/_global/search_shards/SearchShardsRequest.ts @@ -51,6 +51,7 @@ export interface Request extends RequestBase { * A comma-separated list of data streams, indices, and aliases to search. * It supports wildcards (`*`). * To search all data streams and indices, omit this parameter or use `*` or `_all`. + * @ext_doc_id search-multiple-indices */ index?: Indices } diff --git a/specification/_global/search_template/SearchTemplateRequest.ts b/specification/_global/search_template/SearchTemplateRequest.ts index 766a45eb9b..61202789b2 100644 --- a/specification/_global/search_template/SearchTemplateRequest.ts +++ b/specification/_global/search_template/SearchTemplateRequest.ts @@ -58,6 +58,7 @@ export interface Request extends RequestBase { /** * A comma-separated list of data streams, indices, and aliases to search. * It supports wildcards (`*`). + * @ext_doc_id search-multiple-indices */ index?: Indices } diff --git a/specification/_global/termvectors/TermVectorsRequest.ts b/specification/_global/termvectors/TermVectorsRequest.ts index 1e9cb406ea..3d0b1b86a1 100644 --- a/specification/_global/termvectors/TermVectorsRequest.ts +++ b/specification/_global/termvectors/TermVectorsRequest.ts @@ -148,6 +148,7 @@ export interface Request extends RequestBase { realtime?: boolean /** * A custom value that is used to route operations to a specific shard. + * @ext_doc_id search-shard-routing */ routing?: Routing /** @@ -230,6 +231,7 @@ export interface Request extends RequestBase { term_statistics?: boolean /** * A custom value that is used to route operations to a specific shard. + * @ext_doc_id search-shard-routing */ routing?: Routing /** diff --git a/specification/_global/update_by_query/UpdateByQueryRequest.ts b/specification/_global/update_by_query/UpdateByQueryRequest.ts index f1173103a7..bdb2094114 100644 --- a/specification/_global/update_by_query/UpdateByQueryRequest.ts +++ b/specification/_global/update_by_query/UpdateByQueryRequest.ts @@ -150,6 +150,7 @@ export interface Request extends RequestBase { * A comma-separated list of data streams, indices, and aliases to search. * It supports wildcards (`*`). * To search all data streams or indices, omit this parameter or use `*` or `_all`. + * @ext_doc_id search-multiple-indices */ index: Indices } @@ -243,6 +244,7 @@ export interface Request extends RequestBase { /** * If `true`, the request cache is used for this request. * It defaults to the index-level setting. + * @ext_doc_id shard-request-cache */ request_cache?: boolean /** diff --git a/specification/_types/Knn.ts b/specification/_types/Knn.ts index 422cf4d27e..2a6167171e 100644 --- a/specification/_types/Knn.ts +++ b/specification/_types/Knn.ts @@ -58,6 +58,7 @@ export interface KnnSearch { /** * If defined, each search hit will contain inner hits. * @doc_id knn-inner-hits + * @ext_doc_id inner-hits */ inner_hits?: InnerHits /** diff --git a/specification/_types/Rank.ts b/specification/_types/Rank.ts index c24bbf11da..0988277105 100644 --- a/specification/_types/Rank.ts +++ b/specification/_types/Rank.ts @@ -23,7 +23,10 @@ import { long } from '@_types/Numeric' * @variants container */ export class RankContainer { - /** The reciprocal rank fusion parameters */ + /** + * The reciprocal rank fusion parameters + * @ext_doc_id rrf + */ rrf?: RrfRank } diff --git a/specification/_types/query_dsl/joining.ts b/specification/_types/query_dsl/joining.ts index b87c127279..59aa422264 100644 --- a/specification/_types/query_dsl/joining.ts +++ b/specification/_types/query_dsl/joining.ts @@ -50,6 +50,7 @@ export class HasChildQuery extends QueryBase { /** * If defined, each search hit will contain inner hits. * @doc_id inner-hits + * @ext_doc_id inner-hits */ inner_hits?: InnerHits /** @@ -91,6 +92,7 @@ export class HasParentQuery extends QueryBase { /** * If defined, each search hit will contain inner hits. * @doc_id inner-hits + * @ext_doc_id inner-hits */ inner_hits?: InnerHits /** @@ -121,6 +123,7 @@ export class NestedQuery extends QueryBase { /** * If defined, each search hit will contain inner hits. * @doc_id inner-hits + * @ext_doc_id inner-hits */ inner_hits?: InnerHits /** diff --git a/specification/async_search/submit/AsyncSearchSubmitRequest.ts b/specification/async_search/submit/AsyncSearchSubmitRequest.ts index 815968291e..9c6fb9114b 100644 --- a/specification/async_search/submit/AsyncSearchSubmitRequest.ts +++ b/specification/async_search/submit/AsyncSearchSubmitRequest.ts @@ -184,6 +184,7 @@ export interface Request extends RequestBase { /** * Specify if request cache should be used for this request or not, defaults to true * @server_default true + * @ext_doc_id shard-request-cache */ request_cache?: boolean /** @@ -281,6 +282,7 @@ export interface Request extends RequestBase { from?: integer /** * A comma-separated list of : pairs + * @ext_doc_id sort-search-results */ sort?: string | string[] } diff --git a/specification/ilm/explain_lifecycle/ExplainLifecycleRequest.ts b/specification/ilm/explain_lifecycle/ExplainLifecycleRequest.ts index 9aef9eeb4c..472da0f79b 100644 --- a/specification/ilm/explain_lifecycle/ExplainLifecycleRequest.ts +++ b/specification/ilm/explain_lifecycle/ExplainLifecycleRequest.ts @@ -32,6 +32,7 @@ import { Duration } from '@_types/Time' * @availability stack since=6.6.0 stability=stable * @index_privileges view_index_metadata,manage_ilm * @doc_id ilm-explain-lifecycle + * @ext_doc_id explain-lifecycle-state */ export interface Request extends RequestBase { urls: [ diff --git a/specification/indices/create_from/MigrateCreateFromRequest.ts b/specification/indices/create_from/MigrateCreateFromRequest.ts index fd0dc229a3..8589b294b8 100644 --- a/specification/indices/create_from/MigrateCreateFromRequest.ts +++ b/specification/indices/create_from/MigrateCreateFromRequest.ts @@ -31,6 +31,7 @@ import { IndexSettings } from '@indices/_types/IndexSettings' * @availability serverless stability=stable visibility=public * @doc_id migration-api-create-from * @doc_tag migration + * @ext_doc_id create_index_from_source_index */ export interface Request extends RequestBase { urls: [ diff --git a/specification/indices/migrate_reindex/MigrateReindexRequest.ts b/specification/indices/migrate_reindex/MigrateReindexRequest.ts index a54c64c7a8..9ea2da25c8 100644 --- a/specification/indices/migrate_reindex/MigrateReindexRequest.ts +++ b/specification/indices/migrate_reindex/MigrateReindexRequest.ts @@ -30,6 +30,7 @@ import { IndexName, MediaType } from '@_types/common' * @availability stack since=8.18.0 stability=stable * @doc_id migration-api-reindex * @doc_tag migration + * @ext_doc_id reindex_legacy_backing_indices */ export interface Request extends RequestBase { urls: [ diff --git a/specification/indices/refresh/IndicesRefreshRequest.ts b/specification/indices/refresh/IndicesRefreshRequest.ts index c94aca1b92..36879bb31a 100644 --- a/specification/indices/refresh/IndicesRefreshRequest.ts +++ b/specification/indices/refresh/IndicesRefreshRequest.ts @@ -43,6 +43,7 @@ import { ExpandWildcards, Indices, MediaType } from '@_types/common' * @availability serverless stability=stable visibility=public * @doc_id indices-refresh * @index_privileges maintenance + * @ext_doc_id refresh_an_index */ export interface Request extends RequestBase { urls: [ diff --git a/specification/security/update_user_profile_data/Request.ts b/specification/security/update_user_profile_data/Request.ts index 379fc389ac..d7820c91da 100644 --- a/specification/security/update_user_profile_data/Request.ts +++ b/specification/security/update_user_profile_data/Request.ts @@ -67,6 +67,7 @@ export interface Request extends RequestBase { query_parameters: { /** * Only perform the operation if the document has this sequence number. + * @ext_doc_id optimistic-concurrency */ if_seq_no?: SequenceNumber /**