From 4a0eaef2ce8604220d5e089a69a0c2744a00077d Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Thu, 3 Oct 2024 16:50:01 -0700 Subject: [PATCH] [OpenAPI] Add list of tags in overlay (#2905) --- .spectral.yaml | 2 +- Makefile | 12 +- .../elasticsearch-shared-overlays.yaml | 213 +++++++++++++++++ output/openapi/elasticsearch-openapi.json | 224 +++++++++--------- .../elasticsearch-serverless-openapi.json | 166 ++++++------- output/schema/schema.json | 166 ++++++++----- specification/_global/bulk/BulkRequest.ts | 1 + .../clear_scroll/ClearScrollRequest.ts | 1 + .../ClosePointInTimeRequest.ts | 1 + specification/_global/count/CountRequest.ts | 1 + specification/_global/create/CreateRequest.ts | 2 +- specification/_global/delete/DeleteRequest.ts | 1 + .../delete_by_query/DeleteByQueryRequest.ts | 1 + .../delete_script/DeleteScriptRequest.ts | 1 + .../_global/exists/DocumentExistsRequest.ts | 1 + .../exists_source/SourceExistsRequest.ts | 1 + .../_global/explain/ExplainRequest.ts | 1 + .../field_caps/FieldCapabilitiesRequest.ts | 1 + specification/_global/get/GetRequest.ts | 1 + .../_global/get_script/GetScriptRequest.ts | 1 + .../_global/get_source/SourceRequest.ts | 1 + specification/_global/index/IndexRequest.ts | 1 + .../_global/knn_search/KnnSearchRequest.ts | 1 + .../MultiSearchTemplateRequest.ts | 1 + .../OpenPointInTimeRequest.ts | 1 + specification/_global/ping/PingRequest.ts | 1 + .../_global/put_script/PutScriptRequest.ts | 1 + .../_global/rank_eval/RankEvalRequest.ts | 1 + .../_global/reindex/ReindexRequest.ts | 1 + .../ReindexRethrottleRequest.ts | 1 + .../RenderSearchTemplateRequest.ts | 1 + .../ExecutePainlessScriptRequest.ts | 1 + .../_global/search_mvt/SearchMvtRequest.ts | 2 + .../search_shards/SearchShardsRequest.ts | 1 + .../search_template/SearchTemplateRequest.ts | 1 + .../_global/termvectors/TermVectorsRequest.ts | 1 + specification/_global/update/UpdateRequest.ts | 1 + .../update_by_query/UpdateByQueryRequest.ts | 1 + .../delete/AsyncSearchDeleteRequest.ts | 1 + .../async_search/get/AsyncSearchGetRequest.ts | 1 + .../status/AsyncSearchStatusRequest.ts | 1 + .../submit/AsyncSearchSubmitRequest.ts | 1 + .../ClusterDeleteComponentTemplateRequest.ts | 1 + .../ClusterComponentTemplateExistsRequest.ts | 1 + .../ClusterGetComponentTemplateRequest.ts | 1 + .../cluster/health/ClusterHealthRequest.ts | 1 + .../ClusterPutComponentTemplateRequest.ts | 1 + .../IndicesDataStreamsStatsRequest.ts | 1 + .../IndicesGetDataLifecycleRequest.ts | 1 + .../IndicesGetDataStreamRequest.ts | 1 + .../IndicesMigrateToDataStreamRequest.ts | 1 + .../IndicesModifyDataStreamRequest.ts | 1 + ...ClearRepositoriesMeteringArchiveRequest.ts | 1 + .../GetRepositoriesMeteringInfoRequest.ts | 1 + .../hot_threads/NodesHotThreadsRequest.ts | 1 + specification/nodes/info/NodesInfoRequest.ts | 1 + .../ReloadSecureSettingsRequest.ts | 1 + .../nodes/stats/NodesStatsRequest.ts | 1 + .../nodes/usage/NodesUsageRequest.ts | 1 + .../BehavioralAnalyticsDeleteRequest.ts | 1 + .../BehavioralAnalyticsGetRequest.ts | 1 + .../BehavioralAnalyticsPutRequest.ts | 1 + 62 files changed, 583 insertions(+), 258 deletions(-) diff --git a/.spectral.yaml b/.spectral.yaml index 109addd298..151e2b012c 100644 --- a/.spectral.yaml +++ b/.spectral.yaml @@ -17,7 +17,7 @@ rules: operation-operationId: warn operation-operationId-unique: warn operation-operationId-valid-in-url: warn - operation-tag-defined: warn + operation-tag-defined: error operation-tags: warn # Responses operation-success-response: warn diff --git a/Makefile b/Makefile index 0f717615a6..39bc9af68e 100644 --- a/Makefile +++ b/Makefile @@ -69,14 +69,14 @@ overlay-docs: ## Apply overlays to OpenAPI documents rm output/openapi/elasticsearch-serverless-openapi.tmp*.json rm output/openapi/elasticsearch-openapi.tmp*.json -lint-docs: ## Lint the OpenAPI documents - @npx @stoplight/spectral-cli lint output/openapi/*.json --ruleset .spectral.yaml +lint-docs: ## Lint the OpenAPI documents after overlays + @npx @stoplight/spectral-cli lint output/openapi/elasticsearch-*.examples.json --ruleset .spectral.yaml -lint-docs-errs: ## Lint the OpenAPI documents and return only errors - @npx @stoplight/spectral-cli lint output/openapi/*.json --ruleset .spectral.yaml -D +lint-docs-errs: ## Lint the OpenAPI documents after overlays and return only errors + @npx @stoplight/spectral-cli lint output/openapi/elasticsearch-*.examples.json --ruleset .spectral.yaml -D -lint-docs-serverless: ## Lint only the serverless OpenAPI document - @npx @stoplight/spectral-cli lint output/openapi/elasticsearch-serverless-openapi.json --ruleset .spectral.yaml +lint-docs-serverless: ## Lint only the serverless OpenAPI document after overlays + @npx @stoplight/spectral-cli lint output/openapi/elasticsearch-serverless-openapi.examples.json --ruleset .spectral.yaml help: ## Display help @awk 'BEGIN {FS = ":.*##"; printf "Usage:\n make \033[36m\033[0m\n"} /^[a-zA-Z_-]+:.*?##/ { printf " \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST) diff --git a/docs/overlays/elasticsearch-shared-overlays.yaml b/docs/overlays/elasticsearch-shared-overlays.yaml index 5c51c9751d..aedbd12ae0 100644 --- a/docs/overlays/elasticsearch-shared-overlays.yaml +++ b/docs/overlays/elasticsearch-shared-overlays.yaml @@ -12,6 +12,219 @@ actions: externalDocs: url: https://www.elastic.co/guide/en/elasticsearch/reference/master/query-dsl.html description: Query domain specific language (DSL) reference +# Add an alphabetically sorted list of tags + - target: '$' + description: Add document-level tags sorted by display name + update: + tags: + # A + - name: autoscaling + x-displayName: Autoscaling + # B + - name: analytics + x-displayName: Behavioral analytics + # C + - name: cat + x-displayName: Compact and aligned text (CAT) + description: > + The compact and aligned text (CAT) APIs aim are intended only for human consumption using the Kibana console or command line. + They are not intended for use by applications. + For application consumption, it's recommend to use a corresponding JSON API. + + All the cat commands accept a query string parameter `help` to see all the headers and info they provide, and the `/_cat` command alone lists all the available commands. + - name: cluster + x-displayName: Cluster + - name: health_report + x-displayName: Cluster - Health + - name: connector + x-displayName: Connector + description: > + The connector and sync jobs APIs provide a convenient way to create and manage Elastic connectors and sync jobs in an internal index. + + Connectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure: + + * Native connectors are a managed service on Elastic Cloud + * Connector clients are self-managed on your infrastructure + + This API provides an alternative to relying solely on Kibana UI for connector and sync job management. The API comes with a set of validations and assertions to ensure that the state representation in the internal index remains valid. + externalDocs: + url: https://www.elastic.co/guide/en/enterprise-search/current/connectors-tutorial-api.html + description: To get started with Connector APIs, check out the tutorial. + - name: ccr + x-displayName: Cross-cluster replication + # D + - name: data stream + x-displayName: Data stream + externalDocs: + description: Data stream overview + url: https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html + - name: document + x-displayName: Document + externalDocs: + description: Reading and writing documents + url: https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-replication.html + - name: mget + x-displayName: Document - Multi get + - name: mtermvectors + x-displayName: Document - Multi term vectors + - name: delete_by_query_rethrottle + x-displayName: Document - Rethrottle delete by query + - name: update_by_query_rethrottle + x-displayName: Document - Rethrottle update by query + # E + - name: enrich + x-displayName: Enrich + - name: eql + x-displayName: EQL + description: > + Event Query Language (EQL) is a query language for event-based time series data, such as logs, metrics, and traces. + externalDocs: + url: https://www.elastic.co/guide/en/elasticsearch/reference/current/eql.html + description: EQL search + - name: esql + x-displayName: ES|QL + description: > + The Elasticsearch Query Language (ES|QL) provides a powerful way to filter, transform, and analyze data stored in Elasticsearch, and in the future in other runtimes. + externalDocs: + url: https://www.elastic.co/guide/en/elasticsearch/reference/current/esql.html + description: ES|QL overview and tutorials + # F + - name: features + description: The feature APIs enable you to introspect and manage features provided by Elasticsearch and Elasticsearch plugins. + x-displayName: Features + - name: fleet + x-displayName: Fleet + # G + - name: graph + x-displayName: Graph explore + description: > + The graph explore API enables you to extract and summarize information about the documents and terms in an Elasticsearch data stream or index. + externalDocs: + url: https://www.elastic.co/guide/en/kibana/current/xpack-graph.html + description: Getting started with Graph + # I + - name: indices + x-displayName: Index + description: > + Index APIs enable you to manage individual indices, index settings, aliases, mappings, and index templates. + - name: dangling_indices + x-displayName: Index - Import dangling index + - name: ilm + x-displayName: Index lifecycle management + externalDocs: + url: https://www.elastic.co/guide/en/elasticsearch/reference/current/index-lifecycle-management.html + description: Manage the index lifecycle + - name: inference + x-displayName: Inference + description: > + Inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio or Hugging Face. + For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. + However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. + - name: info + x-displayName: Info + - name: ingest + x-displayName: Ingest + description: Ingest APIs enable you to manage tasks and resources related to ingest pipelines and processors. + # L + - name: license + x-displayName: Licensing + description: Licensing APIs enable you to manage your licenses. + - name: logstash + x-displayName: Logstash + description: > + Logstash APIs enable you to manage pipelines that are used by Logstash Central Management. + externalDocs: + url: https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html + description: Centralized pipeline management + # M + - name: ml + x-displayName: Machine learning + - name: migration + x-displayName: Migration + - name: monitoring + x-displayName: Monitoring + # N + - name: shutdown + x-displayName: Node lifecycle + # Q + - name: query_rules + x-displayName: Query rules + description: > + Query rules enable you to configure per-query rules that are applied at query time to queries that match the specific rule. + Query rules are organized into rulesets, collections of query rules that are matched against incoming queries. + Query rules are applied using the rule query. + + If a query matches one or more rules in the ruleset, the query is re-written to apply the rules before searching. + This allows pinning documents for only queries that match a specific term. + externalDocs: + url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-rule-query.html + description: Rule query + # R + - name: rollup + x-displayName: Rollup + # S + - name: script + x-displayName: Script + - name: get_script_context + x-displayName: Script - Get contexts + - name: get_script_languages + x-displayName: Script - Get languages + - name: search + x-displayName: Search + - name: msearch + x-displayName: Search - Multi search + - name: scroll + x-displayName: Search - Scroll + - name: terms_enum + x-displayName: Search - Terms enum + - name: search_application + x-displayName: Search application + - name: searchable_snapshots + x-displayName: Searchable snapshots + - name: security + x-displayName: Security + - name: ssl + x-displayName: Security - SSL + - name: snapshot + x-displayName: Snapshot and restore + description: > + Snapshot and restore APIs enable you to set up snapshot repositories, manage snapshot backups, and restore snapshots to a running cluster. + externalDocs: + url: https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshot-restore.html + description: Snapshot and restore + - name: slm + x-displayName: Snapshot lifecycle management + description: > + Snapshot lifecycle management (SLM) APIs enable you to set up policies to automatically take snapshots and control how long they are retained. + externalDocs: + url: https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-take-snapshot.html + description: Create a snapshot + - name: sql + x-displayName: SQL + description: > + Elasticsearch's SQL APIs enable you to run SQL queries on Elasticsearch indices and data streams. + externalDocs: + url: https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-sql.html + description: An overview and tutorials for the Elasticsearch SQL features + - name: synonyms + x-displayName: Synonyms + description: > + The synonyms management API provides a convenient way to define and manage synonyms in an internal system index. + Related synonyms can be grouped in a "synonyms set". + Create as many synonym sets as you need. + # T + - name: tasks + x-displayName: Task management + - name: text_structure + x-displayName: Text structure + - name: transform + x-displayName: Transform + # U + - name: xpack + x-displayName: Usage + # W + - name: watcher + x-displayName: Watcher # Abbreviate and annotate items that are not shown in Bump.sh due to depth limits - target: "$.components['schemas']['ml._types:Datafeed'].properties.query" description: Remove query object from anomaly detection datafeed diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 89d4acf9ff..9039dfb71b 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -12,7 +12,7 @@ "/_async_search/{id}": { "get": { "tags": [ - "async_search" + "search" ], "summary": "Retrieves the results of a previously submitted async search request given its identifier", "description": "If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.", @@ -76,7 +76,7 @@ }, "delete": { "tags": [ - "async_search" + "search" ], "summary": "Deletes an async search by identifier", "description": "If the search is still running, the search request will be cancelled.\nOtherwise, the saved search results are deleted.\nIf the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.", @@ -112,7 +112,7 @@ "/_async_search/status/{id}": { "get": { "tags": [ - "async_search" + "search" ], "summary": "Get async search status\n", "description": "Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", @@ -148,7 +148,7 @@ "/_async_search": { "post": { "tags": [ - "async_search" + "search" ], "summary": "Runs a search request asynchronously", "description": "When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.\nWarning: Async search does not support scroll nor search requests that only include the suggest section.\nBy default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", @@ -307,7 +307,7 @@ "/{index}/_async_search": { "post": { "tags": [ - "async_search" + "search" ], "summary": "Runs a search request asynchronously", "description": "When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.\nWarning: Async search does not support scroll nor search requests that only include the suggest section.\nBy default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", @@ -617,7 +617,7 @@ "/_bulk": { "put": { "tags": [ - "bulk" + "document" ], "summary": "Bulk index or delete documents", "description": "Performs multiple indexing or delete operations in a single API call.\nThis reduces overhead and can greatly increase indexing speed.", @@ -662,7 +662,7 @@ }, "post": { "tags": [ - "bulk" + "document" ], "summary": "Bulk index or delete documents", "description": "Performs multiple indexing or delete operations in a single API call.\nThis reduces overhead and can greatly increase indexing speed.", @@ -709,7 +709,7 @@ "/{index}/_bulk": { "put": { "tags": [ - "bulk" + "document" ], "summary": "Bulk index or delete documents", "description": "Performs multiple indexing or delete operations in a single API call.\nThis reduces overhead and can greatly increase indexing speed.", @@ -757,7 +757,7 @@ }, "post": { "tags": [ - "bulk" + "document" ], "summary": "Bulk index or delete documents", "description": "Performs multiple indexing or delete operations in a single API call.\nThis reduces overhead and can greatly increase indexing speed.", @@ -2789,7 +2789,7 @@ }, "delete": { "tags": [ - "clear_scroll" + "search" ], "summary": "Clears the search context and results for a scrolling search", "operationId": "clear-scroll", @@ -2864,7 +2864,7 @@ }, "delete": { "tags": [ - "clear_scroll" + "search" ], "summary": "Clears the search context and results for a scrolling search", "operationId": "clear-scroll-1", @@ -2886,7 +2886,7 @@ "/_pit": { "delete": { "tags": [ - "close_point_in_time" + "search" ], "summary": "Closes a point-in-time", "operationId": "close-point-in-time", @@ -2987,7 +2987,7 @@ "/_component_template/{name}": { "get": { "tags": [ - "cluster" + "indices" ], "summary": "Get component templates", "description": "Retrieves information about component templates.", @@ -3018,7 +3018,7 @@ }, "put": { "tags": [ - "cluster" + "indices" ], "summary": "Create or update a component template", "description": "Creates or updates a component template.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nAn index template can be composed of multiple component templates.\nTo use a component template, specify it in an index template’s `composed_of` list.\nComponent templates are only applied to new data streams and indices as part of a matching index template.\n\nSettings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.\n\nComponent templates are only used during index creation.\nFor data streams, this includes data stream creation and the creation of a stream’s backing indices.\nChanges to component templates do not affect existing indices, including a stream’s backing indices.\n\nYou can use C-style `/* *\\/` block comments in component templates.\nYou can include comments anywhere in the request body except before the opening curly bracket.", @@ -3046,7 +3046,7 @@ }, "post": { "tags": [ - "cluster" + "indices" ], "summary": "Create or update a component template", "description": "Creates or updates a component template.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nAn index template can be composed of multiple component templates.\nTo use a component template, specify it in an index template’s `composed_of` list.\nComponent templates are only applied to new data streams and indices as part of a matching index template.\n\nSettings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.\n\nComponent templates are only used during index creation.\nFor data streams, this includes data stream creation and the creation of a stream’s backing indices.\nChanges to component templates do not affect existing indices, including a stream’s backing indices.\n\nYou can use C-style `/* *\\/` block comments in component templates.\nYou can include comments anywhere in the request body except before the opening curly bracket.", @@ -3074,7 +3074,7 @@ }, "delete": { "tags": [ - "cluster" + "indices" ], "summary": "Delete component templates", "description": "Deletes component templates.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.", @@ -3128,7 +3128,7 @@ }, "head": { "tags": [ - "cluster" + "indices" ], "summary": "Check component templates", "description": "Returns information about whether a particular component template exists.", @@ -3258,7 +3258,7 @@ "/_component_template": { "get": { "tags": [ - "cluster" + "indices" ], "summary": "Get component templates", "description": "Retrieves information about component templates.", @@ -5519,7 +5519,7 @@ "/_count": { "get": { "tags": [ - "count" + "search" ], "summary": "Returns number of documents matching a query", "operationId": "count-1", @@ -5578,7 +5578,7 @@ }, "post": { "tags": [ - "count" + "search" ], "summary": "Returns number of documents matching a query", "operationId": "count", @@ -5639,7 +5639,7 @@ "/{index}/_count": { "get": { "tags": [ - "count" + "search" ], "summary": "Returns number of documents matching a query", "operationId": "count-3", @@ -5701,7 +5701,7 @@ }, "post": { "tags": [ - "count" + "search" ], "summary": "Returns number of documents matching a query", "operationId": "count-2", @@ -5765,7 +5765,7 @@ "/{index}/_create/{id}": { "put": { "tags": [ - "create" + "document" ], "summary": "Index a document", "description": "Adds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", @@ -5811,7 +5811,7 @@ }, "post": { "tags": [ - "create" + "document" ], "summary": "Index a document", "description": "Adds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", @@ -6022,7 +6022,7 @@ "/{index}/_doc/{id}": { "get": { "tags": [ - "get" + "document" ], "summary": "Get a document by its ID", "description": "Retrieves the document with the specified ID from an index.", @@ -6176,7 +6176,7 @@ }, "put": { "tags": [ - "index" + "document" ], "summary": "Index a document", "description": "Adds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", @@ -6233,7 +6233,7 @@ }, "post": { "tags": [ - "index" + "document" ], "summary": "Index a document", "description": "Adds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", @@ -6290,7 +6290,7 @@ }, "delete": { "tags": [ - "delete" + "document" ], "summary": "Delete a document", "description": "Removes a JSON document from the specified index.", @@ -6414,7 +6414,7 @@ }, "head": { "tags": [ - "exists" + "document" ], "summary": "Check a document", "description": "Checks if a specified document exists.", @@ -6556,7 +6556,7 @@ "/{index}/_delete_by_query": { "post": { "tags": [ - "delete_by_query" + "document" ], "summary": "Delete documents", "description": "Deletes documents that match the specified query.", @@ -7008,7 +7008,7 @@ "/_scripts/{id}": { "get": { "tags": [ - "get_script" + "script" ], "summary": "Get a script or search template", "description": "Retrieves a stored script or search template.", @@ -7066,7 +7066,7 @@ }, "put": { "tags": [ - "put_script" + "script" ], "summary": "Create or update a script or search template", "description": "Creates or updates a stored script or search template.", @@ -7093,7 +7093,7 @@ }, "post": { "tags": [ - "put_script" + "script" ], "summary": "Create or update a script or search template", "description": "Creates or updates a stored script or search template.", @@ -7120,7 +7120,7 @@ }, "delete": { "tags": [ - "delete_script" + "script" ], "summary": "Delete a script or search template", "description": "Deletes a stored script or search template.", @@ -7744,7 +7744,7 @@ "/{index}/_source/{id}": { "get": { "tags": [ - "get_source" + "document" ], "summary": "Get a document's source", "description": "Returns the source of a document.", @@ -7887,7 +7887,7 @@ }, "head": { "tags": [ - "exists_source" + "document" ], "summary": "Check for a document source", "description": "Checks if a document's `_source` is stored.", @@ -8020,7 +8020,7 @@ "/{index}/_explain/{id}": { "get": { "tags": [ - "explain" + "search" ], "summary": "Explain a document match result", "description": "Returns information about why a specific document matches, or doesn’t match, a query.", @@ -8080,7 +8080,7 @@ }, "post": { "tags": [ - "explain" + "search" ], "summary": "Explain a document match result", "description": "Returns information about why a specific document matches, or doesn’t match, a query.", @@ -8209,7 +8209,7 @@ "/_field_caps": { "get": { "tags": [ - "field_caps" + "search" ], "summary": "The field capabilities API returns the information about the capabilities of fields among multiple indices", "description": "The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type\nof keyword is returned as any other field that belongs to the `keyword` family.", @@ -8252,7 +8252,7 @@ }, "post": { "tags": [ - "field_caps" + "search" ], "summary": "The field capabilities API returns the information about the capabilities of fields among multiple indices", "description": "The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type\nof keyword is returned as any other field that belongs to the `keyword` family.", @@ -8297,7 +8297,7 @@ "/{index}/_field_caps": { "get": { "tags": [ - "field_caps" + "search" ], "summary": "The field capabilities API returns the information about the capabilities of fields among multiple indices", "description": "The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type\nof keyword is returned as any other field that belongs to the `keyword` family.", @@ -8343,7 +8343,7 @@ }, "post": { "tags": [ - "field_caps" + "search" ], "summary": "The field capabilities API returns the information about the capabilities of fields among multiple indices", "description": "The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type\nof keyword is returned as any other field that belongs to the `keyword` family.", @@ -9839,7 +9839,7 @@ "/{index}/_doc": { "post": { "tags": [ - "index" + "document" ], "summary": "Index a document", "description": "Adds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", @@ -10738,7 +10738,7 @@ "/_data_stream/{name}": { "get": { "tags": [ - "indices" + "data stream" ], "summary": "Get data streams", "description": "Retrieves information about one or more data streams.", @@ -10879,7 +10879,7 @@ "/_data_stream/_stats": { "get": { "tags": [ - "indices" + "data stream" ], "summary": "Get data stream stats", "description": "Retrieves statistics for one or more data streams.", @@ -10900,7 +10900,7 @@ "/_data_stream/{name}/_stats": { "get": { "tags": [ - "indices" + "data stream" ], "summary": "Get data stream stats", "description": "Retrieves statistics for one or more data streams.", @@ -11168,7 +11168,7 @@ "/_data_stream/{name}/_lifecycle": { "get": { "tags": [ - "indices" + "data stream" ], "summary": "Get data stream lifecycles", "description": "Retrieves the data stream lifecycle configuration of one or more data streams.", @@ -12427,7 +12427,7 @@ "/_data_stream": { "get": { "tags": [ - "indices" + "data stream" ], "summary": "Get data streams", "description": "Retrieves information about one or more data streams.", @@ -12976,7 +12976,7 @@ "/_data_stream/_migrate/{name}": { "post": { "tags": [ - "indices" + "data stream" ], "summary": "Convert an index alias to a data stream", "description": "Converts an index alias to a data stream.\nYou must have a matching index template that is data stream enabled.\nThe alias must meet the following criteria:\nThe alias must have a write index;\nAll indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type;\nThe alias must not have any filters;\nThe alias must not use custom routing.\nIf successful, the request removes the alias and creates a data stream with the same name.\nThe indices for the alias become hidden backing indices for the stream.\nThe write index for the alias becomes the write index for the stream.", @@ -13032,7 +13032,7 @@ "/_data_stream/_modify": { "post": { "tags": [ - "indices" + "data stream" ], "summary": "Update data streams", "description": "Performs one or more data stream modification actions in a single atomic operation.", @@ -14925,7 +14925,7 @@ }, "head": { "tags": [ - "ping" + "cluster" ], "summary": "Ping the cluster", "description": "Returns whether the cluster is running.", @@ -15488,7 +15488,7 @@ "/{index}/_knn_search": { "get": { "tags": [ - "knn_search" + "search" ], "summary": "Performs a kNN search", "operationId": "knn-search", @@ -15514,7 +15514,7 @@ }, "post": { "tags": [ - "knn_search" + "search" ], "summary": "Performs a kNN search", "operationId": "knn-search-1", @@ -22594,7 +22594,7 @@ "/_msearch/template": { "get": { "tags": [ - "msearch_template" + "search" ], "summary": "Runs multiple templated searches with a single request", "operationId": "msearch-template", @@ -22627,7 +22627,7 @@ }, "post": { "tags": [ - "msearch_template" + "search" ], "summary": "Runs multiple templated searches with a single request", "operationId": "msearch-template-1", @@ -22662,7 +22662,7 @@ "/{index}/_msearch/template": { "get": { "tags": [ - "msearch_template" + "search" ], "summary": "Runs multiple templated searches with a single request", "operationId": "msearch-template-2", @@ -22698,7 +22698,7 @@ }, "post": { "tags": [ - "msearch_template" + "search" ], "summary": "Runs multiple templated searches with a single request", "operationId": "msearch-template-3", @@ -22958,7 +22958,7 @@ "/_nodes/{node_id}/_repositories_metering/{max_archive_version}": { "delete": { "tags": [ - "nodes" + "cluster" ], "summary": "You can use this API to clear the archived repositories metering information in the cluster", "operationId": "nodes-clear-repositories-metering-archive", @@ -23005,7 +23005,7 @@ "/_nodes/{node_id}/_repositories_metering": { "get": { "tags": [ - "nodes" + "cluster" ], "summary": "You can use the cluster repositories metering API to retrieve repositories metering information in a cluster", "description": "This API exposes monotonically non-decreasing counters and it’s expected that clients would durably store the\ninformation needed to compute aggregations over a period of time. Additionally, the information exposed by this\nAPI is volatile, meaning that it won’t be present after node restarts.", @@ -23042,7 +23042,7 @@ "/_nodes/hot_threads": { "get": { "tags": [ - "nodes" + "cluster" ], "summary": "This API yields a breakdown of the hot threads on each selected node in the cluster", "description": "The output is plain text with a breakdown of each node’s top hot threads.", @@ -23083,7 +23083,7 @@ "/_nodes/{node_id}/hot_threads": { "get": { "tags": [ - "nodes" + "cluster" ], "summary": "This API yields a breakdown of the hot threads on each selected node in the cluster", "description": "The output is plain text with a breakdown of each node’s top hot threads.", @@ -23127,7 +23127,7 @@ "/_nodes": { "get": { "tags": [ - "nodes" + "cluster" ], "summary": "Returns cluster nodes information", "operationId": "nodes-info", @@ -23153,7 +23153,7 @@ "/_nodes/{node_id}": { "get": { "tags": [ - "nodes" + "cluster" ], "summary": "Returns cluster nodes information", "operationId": "nodes-info-1", @@ -23182,7 +23182,7 @@ "/_nodes/{metric}": { "get": { "tags": [ - "nodes" + "cluster" ], "summary": "Returns cluster nodes information", "operationId": "nodes-info-2", @@ -23211,7 +23211,7 @@ "/_nodes/{node_id}/{metric}": { "get": { "tags": [ - "nodes" + "cluster" ], "summary": "Returns cluster nodes information", "operationId": "nodes-info-3", @@ -23243,7 +23243,7 @@ "/_nodes/reload_secure_settings": { "post": { "tags": [ - "nodes" + "cluster" ], "summary": "Reloads the keystore on nodes in the cluster", "operationId": "nodes-reload-secure-settings", @@ -23266,7 +23266,7 @@ "/_nodes/{node_id}/reload_secure_settings": { "post": { "tags": [ - "nodes" + "cluster" ], "summary": "Reloads the keystore on nodes in the cluster", "operationId": "nodes-reload-secure-settings-1", @@ -23292,7 +23292,7 @@ "/_nodes/stats": { "get": { "tags": [ - "nodes" + "cluster" ], "summary": "Returns cluster nodes statistics", "operationId": "nodes-stats", @@ -23338,7 +23338,7 @@ "/_nodes/{node_id}/stats": { "get": { "tags": [ - "nodes" + "cluster" ], "summary": "Returns cluster nodes statistics", "operationId": "nodes-stats-1", @@ -23387,7 +23387,7 @@ "/_nodes/stats/{metric}": { "get": { "tags": [ - "nodes" + "cluster" ], "summary": "Returns cluster nodes statistics", "operationId": "nodes-stats-2", @@ -23436,7 +23436,7 @@ "/_nodes/{node_id}/stats/{metric}": { "get": { "tags": [ - "nodes" + "cluster" ], "summary": "Returns cluster nodes statistics", "operationId": "nodes-stats-3", @@ -23488,7 +23488,7 @@ "/_nodes/stats/{metric}/{index_metric}": { "get": { "tags": [ - "nodes" + "cluster" ], "summary": "Returns cluster nodes statistics", "operationId": "nodes-stats-4", @@ -23540,7 +23540,7 @@ "/_nodes/{node_id}/stats/{metric}/{index_metric}": { "get": { "tags": [ - "nodes" + "cluster" ], "summary": "Returns cluster nodes statistics", "operationId": "nodes-stats-5", @@ -23595,7 +23595,7 @@ "/_nodes/usage": { "get": { "tags": [ - "nodes" + "cluster" ], "summary": "Returns information on the usage of features", "operationId": "nodes-usage", @@ -23615,7 +23615,7 @@ "/_nodes/{node_id}/usage": { "get": { "tags": [ - "nodes" + "cluster" ], "summary": "Returns information on the usage of features", "operationId": "nodes-usage-1", @@ -23638,7 +23638,7 @@ "/_nodes/usage/{metric}": { "get": { "tags": [ - "nodes" + "cluster" ], "summary": "Returns information on the usage of features", "operationId": "nodes-usage-2", @@ -23661,7 +23661,7 @@ "/_nodes/{node_id}/usage/{metric}": { "get": { "tags": [ - "nodes" + "cluster" ], "summary": "Returns information on the usage of features", "operationId": "nodes-usage-3", @@ -23687,7 +23687,7 @@ "/{index}/_pit": { "post": { "tags": [ - "open_point_in_time" + "search" ], "summary": "A search request by default executes against the most recent visible data of the target indices,\n", "description": "which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the\nstate of the data as it existed when initiated. In some cases, it’s preferred to perform multiple\nsearch requests using the same point in time. For example, if refreshes happen between\n`search_after` requests, then the results of those requests might not be consistent as changes happening\nbetween searches are only visible to the more recent point in time.", @@ -23800,7 +23800,7 @@ "/_scripts/{id}/{context}": { "put": { "tags": [ - "put_script" + "script" ], "summary": "Create or update a script or search template", "description": "Creates or updates a stored script or search template.", @@ -23830,7 +23830,7 @@ }, "post": { "tags": [ - "put_script" + "script" ], "summary": "Create or update a script or search template", "description": "Creates or updates a stored script or search template.", @@ -24239,7 +24239,7 @@ "/_rank_eval": { "get": { "tags": [ - "rank_eval" + "search" ], "summary": "Enables you to evaluate the quality of ranked search results over a set of typical search queries", "operationId": "rank-eval", @@ -24269,7 +24269,7 @@ }, "post": { "tags": [ - "rank_eval" + "search" ], "summary": "Enables you to evaluate the quality of ranked search results over a set of typical search queries", "operationId": "rank-eval-1", @@ -24301,7 +24301,7 @@ "/{index}/_rank_eval": { "get": { "tags": [ - "rank_eval" + "search" ], "summary": "Enables you to evaluate the quality of ranked search results over a set of typical search queries", "operationId": "rank-eval-2", @@ -24334,7 +24334,7 @@ }, "post": { "tags": [ - "rank_eval" + "search" ], "summary": "Enables you to evaluate the quality of ranked search results over a set of typical search queries", "operationId": "rank-eval-3", @@ -24369,7 +24369,7 @@ "/_reindex": { "post": { "tags": [ - "reindex" + "document" ], "summary": "Reindex documents", "description": "Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself.", @@ -24562,7 +24562,7 @@ "/_reindex/{task_id}/_rethrottle": { "post": { "tags": [ - "reindex_rethrottle" + "document" ], "summary": "Copies documents from a source to a destination", "operationId": "reindex-rethrottle", @@ -24618,7 +24618,7 @@ "/_render/template": { "get": { "tags": [ - "render_search_template" + "search" ], "summary": "Renders a search template as a search request body", "operationId": "render-search-template", @@ -24633,7 +24633,7 @@ }, "post": { "tags": [ - "render_search_template" + "search" ], "summary": "Renders a search template as a search request body", "operationId": "render-search-template-1", @@ -24650,7 +24650,7 @@ "/_render/template/{id}": { "get": { "tags": [ - "render_search_template" + "search" ], "summary": "Renders a search template as a search request body", "operationId": "render-search-template-2", @@ -24670,7 +24670,7 @@ }, "post": { "tags": [ - "render_search_template" + "search" ], "summary": "Renders a search template as a search request body", "operationId": "render-search-template-3", @@ -25103,7 +25103,7 @@ "/_scripts/painless/_execute": { "get": { "tags": [ - "scripts_painless_execute" + "script" ], "summary": "Run a script", "description": "Runs a script and returns a result.", @@ -25121,7 +25121,7 @@ }, "post": { "tags": [ - "scripts_painless_execute" + "script" ], "summary": "Run a script", "description": "Runs a script and returns a result.", @@ -25896,7 +25896,7 @@ "/_application/analytics/{name}": { "get": { "tags": [ - "search_application" + "analytics" ], "summary": "Get behavioral analytics collections", "operationId": "search-application-get-behavioral-analytics-1", @@ -25915,7 +25915,7 @@ }, "put": { "tags": [ - "search_application" + "analytics" ], "summary": "Create a behavioral analytics collection", "operationId": "search-application-put-behavioral-analytics", @@ -25949,7 +25949,7 @@ }, "delete": { "tags": [ - "search_application" + "analytics" ], "summary": "Delete a behavioral analytics collection", "description": "The associated data stream is also deleted.", @@ -25986,7 +25986,7 @@ "/_application/analytics": { "get": { "tags": [ - "search_application" + "analytics" ], "summary": "Get behavioral analytics collections", "operationId": "search-application-get-behavioral-analytics", @@ -26126,7 +26126,7 @@ "/{index}/_mvt/{field}/{zoom}/{x}/{y}": { "get": { "tags": [ - "search_mvt" + "search" ], "summary": "Search a vector tile", "description": "Searches a vector tile for geospatial values.", @@ -26181,7 +26181,7 @@ }, "post": { "tags": [ - "search_mvt" + "search" ], "summary": "Search a vector tile", "description": "Searches a vector tile for geospatial values.", @@ -26238,7 +26238,7 @@ "/_search_shards": { "get": { "tags": [ - "search_shards" + "search" ], "summary": "Returns information about the indices and shards that a search request would be executed against", "operationId": "search-shards", @@ -26270,7 +26270,7 @@ }, "post": { "tags": [ - "search_shards" + "search" ], "summary": "Returns information about the indices and shards that a search request would be executed against", "operationId": "search-shards-1", @@ -26304,7 +26304,7 @@ "/{index}/_search_shards": { "get": { "tags": [ - "search_shards" + "search" ], "summary": "Returns information about the indices and shards that a search request would be executed against", "operationId": "search-shards-2", @@ -26339,7 +26339,7 @@ }, "post": { "tags": [ - "search_shards" + "search" ], "summary": "Returns information about the indices and shards that a search request would be executed against", "operationId": "search-shards-3", @@ -26376,7 +26376,7 @@ "/_search/template": { "get": { "tags": [ - "search_template" + "search" ], "summary": "Runs a search with a search template", "operationId": "search-template", @@ -26433,7 +26433,7 @@ }, "post": { "tags": [ - "search_template" + "search" ], "summary": "Runs a search with a search template", "operationId": "search-template-1", @@ -26492,7 +26492,7 @@ "/{index}/_search/template": { "get": { "tags": [ - "search_template" + "search" ], "summary": "Runs a search with a search template", "operationId": "search-template-2", @@ -26552,7 +26552,7 @@ }, "post": { "tags": [ - "search_template" + "search" ], "summary": "Runs a search with a search template", "operationId": "search-template-3", @@ -32762,7 +32762,7 @@ "/{index}/_termvectors/{id}": { "get": { "tags": [ - "termvectors" + "document" ], "summary": "Get term vector information", "description": "Returns information and statistics about terms in the fields of a particular document.", @@ -32819,7 +32819,7 @@ }, "post": { "tags": [ - "termvectors" + "document" ], "summary": "Get term vector information", "description": "Returns information and statistics about terms in the fields of a particular document.", @@ -32878,7 +32878,7 @@ "/{index}/_termvectors": { "get": { "tags": [ - "termvectors" + "document" ], "summary": "Get term vector information", "description": "Returns information and statistics about terms in the fields of a particular document.", @@ -32932,7 +32932,7 @@ }, "post": { "tags": [ - "termvectors" + "document" ], "summary": "Get term vector information", "description": "Returns information and statistics about terms in the fields of a particular document.", @@ -34185,7 +34185,7 @@ "/{index}/_update/{id}": { "post": { "tags": [ - "update" + "document" ], "summary": "Update a document", "description": "Updates a document by running a script or passing a partial document.", @@ -34389,7 +34389,7 @@ "/{index}/_update_by_query": { "post": { "tags": [ - "update_by_query" + "document" ], "summary": "Update documents", "description": "Updates documents that match the specified query.\nIf no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes.", diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 60418b1f38..c897d03852 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -12,7 +12,7 @@ "/_async_search/{id}": { "get": { "tags": [ - "async_search" + "search" ], "summary": "Retrieves the results of a previously submitted async search request given its identifier", "description": "If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.", @@ -76,7 +76,7 @@ }, "delete": { "tags": [ - "async_search" + "search" ], "summary": "Deletes an async search by identifier", "description": "If the search is still running, the search request will be cancelled.\nOtherwise, the saved search results are deleted.\nIf the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.", @@ -112,7 +112,7 @@ "/_async_search/status/{id}": { "get": { "tags": [ - "async_search" + "search" ], "summary": "Get async search status\n", "description": "Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", @@ -148,7 +148,7 @@ "/_async_search": { "post": { "tags": [ - "async_search" + "search" ], "summary": "Runs a search request asynchronously", "description": "When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.\nWarning: Async search does not support scroll nor search requests that only include the suggest section.\nBy default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", @@ -307,7 +307,7 @@ "/{index}/_async_search": { "post": { "tags": [ - "async_search" + "search" ], "summary": "Runs a search request asynchronously", "description": "When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.\nWarning: Async search does not support scroll nor search requests that only include the suggest section.\nBy default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", @@ -469,7 +469,7 @@ "/_bulk": { "put": { "tags": [ - "bulk" + "document" ], "summary": "Bulk index or delete documents", "description": "Performs multiple indexing or delete operations in a single API call.\nThis reduces overhead and can greatly increase indexing speed.", @@ -514,7 +514,7 @@ }, "post": { "tags": [ - "bulk" + "document" ], "summary": "Bulk index or delete documents", "description": "Performs multiple indexing or delete operations in a single API call.\nThis reduces overhead and can greatly increase indexing speed.", @@ -561,7 +561,7 @@ "/{index}/_bulk": { "put": { "tags": [ - "bulk" + "document" ], "summary": "Bulk index or delete documents", "description": "Performs multiple indexing or delete operations in a single API call.\nThis reduces overhead and can greatly increase indexing speed.", @@ -609,7 +609,7 @@ }, "post": { "tags": [ - "bulk" + "document" ], "summary": "Bulk index or delete documents", "description": "Performs multiple indexing or delete operations in a single API call.\nThis reduces overhead and can greatly increase indexing speed.", @@ -1275,7 +1275,7 @@ }, "delete": { "tags": [ - "clear_scroll" + "search" ], "summary": "Clears the search context and results for a scrolling search", "operationId": "clear-scroll", @@ -1350,7 +1350,7 @@ }, "delete": { "tags": [ - "clear_scroll" + "search" ], "summary": "Clears the search context and results for a scrolling search", "operationId": "clear-scroll-1", @@ -1372,7 +1372,7 @@ "/_pit": { "delete": { "tags": [ - "close_point_in_time" + "search" ], "summary": "Closes a point-in-time", "operationId": "close-point-in-time", @@ -1423,7 +1423,7 @@ "/_component_template/{name}": { "get": { "tags": [ - "cluster" + "indices" ], "summary": "Get component templates", "description": "Retrieves information about component templates.", @@ -1454,7 +1454,7 @@ }, "put": { "tags": [ - "cluster" + "indices" ], "summary": "Create or update a component template", "description": "Creates or updates a component template.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nAn index template can be composed of multiple component templates.\nTo use a component template, specify it in an index template’s `composed_of` list.\nComponent templates are only applied to new data streams and indices as part of a matching index template.\n\nSettings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.\n\nComponent templates are only used during index creation.\nFor data streams, this includes data stream creation and the creation of a stream’s backing indices.\nChanges to component templates do not affect existing indices, including a stream’s backing indices.\n\nYou can use C-style `/* *\\/` block comments in component templates.\nYou can include comments anywhere in the request body except before the opening curly bracket.", @@ -1482,7 +1482,7 @@ }, "post": { "tags": [ - "cluster" + "indices" ], "summary": "Create or update a component template", "description": "Creates or updates a component template.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nAn index template can be composed of multiple component templates.\nTo use a component template, specify it in an index template’s `composed_of` list.\nComponent templates are only applied to new data streams and indices as part of a matching index template.\n\nSettings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.\n\nComponent templates are only used during index creation.\nFor data streams, this includes data stream creation and the creation of a stream’s backing indices.\nChanges to component templates do not affect existing indices, including a stream’s backing indices.\n\nYou can use C-style `/* *\\/` block comments in component templates.\nYou can include comments anywhere in the request body except before the opening curly bracket.", @@ -1510,7 +1510,7 @@ }, "delete": { "tags": [ - "cluster" + "indices" ], "summary": "Delete component templates", "description": "Deletes component templates.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.", @@ -1564,7 +1564,7 @@ }, "head": { "tags": [ - "cluster" + "indices" ], "summary": "Check component templates", "description": "Returns information about whether a particular component template exists.", @@ -1616,7 +1616,7 @@ "/_component_template": { "get": { "tags": [ - "cluster" + "indices" ], "summary": "Get component templates", "description": "Retrieves information about component templates.", @@ -3111,7 +3111,7 @@ "/_count": { "get": { "tags": [ - "count" + "search" ], "summary": "Returns number of documents matching a query", "operationId": "count-1", @@ -3170,7 +3170,7 @@ }, "post": { "tags": [ - "count" + "search" ], "summary": "Returns number of documents matching a query", "operationId": "count", @@ -3231,7 +3231,7 @@ "/{index}/_count": { "get": { "tags": [ - "count" + "search" ], "summary": "Returns number of documents matching a query", "operationId": "count-3", @@ -3293,7 +3293,7 @@ }, "post": { "tags": [ - "count" + "search" ], "summary": "Returns number of documents matching a query", "operationId": "count-2", @@ -3357,7 +3357,7 @@ "/{index}/_create/{id}": { "put": { "tags": [ - "create" + "document" ], "summary": "Index a document", "description": "Adds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", @@ -3403,7 +3403,7 @@ }, "post": { "tags": [ - "create" + "document" ], "summary": "Index a document", "description": "Adds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", @@ -3451,7 +3451,7 @@ "/{index}/_doc/{id}": { "get": { "tags": [ - "get" + "document" ], "summary": "Get a document by its ID", "description": "Retrieves the document with the specified ID from an index.", @@ -3595,7 +3595,7 @@ }, "put": { "tags": [ - "index" + "document" ], "summary": "Index a document", "description": "Adds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", @@ -3652,7 +3652,7 @@ }, "post": { "tags": [ - "index" + "document" ], "summary": "Index a document", "description": "Adds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", @@ -3709,7 +3709,7 @@ }, "delete": { "tags": [ - "delete" + "document" ], "summary": "Delete a document", "description": "Removes a JSON document from the specified index.", @@ -3833,7 +3833,7 @@ }, "head": { "tags": [ - "exists" + "document" ], "summary": "Check a document", "description": "Checks if a specified document exists.", @@ -3975,7 +3975,7 @@ "/{index}/_delete_by_query": { "post": { "tags": [ - "delete_by_query" + "document" ], "summary": "Delete documents", "description": "Deletes documents that match the specified query.", @@ -4382,7 +4382,7 @@ "/_scripts/{id}": { "get": { "tags": [ - "get_script" + "script" ], "summary": "Get a script or search template", "description": "Retrieves a stored script or search template.", @@ -4440,7 +4440,7 @@ }, "put": { "tags": [ - "put_script" + "script" ], "summary": "Create or update a script or search template", "description": "Creates or updates a stored script or search template.", @@ -4467,7 +4467,7 @@ }, "post": { "tags": [ - "put_script" + "script" ], "summary": "Create or update a script or search template", "description": "Creates or updates a stored script or search template.", @@ -4494,7 +4494,7 @@ }, "delete": { "tags": [ - "delete_script" + "script" ], "summary": "Delete a script or search template", "description": "Deletes a stored script or search template.", @@ -5118,7 +5118,7 @@ "/{index}/_source/{id}": { "get": { "tags": [ - "get_source" + "document" ], "summary": "Get a document's source", "description": "Returns the source of a document.", @@ -5261,7 +5261,7 @@ }, "head": { "tags": [ - "exists_source" + "document" ], "summary": "Check for a document source", "description": "Checks if a document's `_source` is stored.", @@ -5394,7 +5394,7 @@ "/{index}/_explain/{id}": { "get": { "tags": [ - "explain" + "search" ], "summary": "Explain a document match result", "description": "Returns information about why a specific document matches, or doesn’t match, a query.", @@ -5454,7 +5454,7 @@ }, "post": { "tags": [ - "explain" + "search" ], "summary": "Explain a document match result", "description": "Returns information about why a specific document matches, or doesn’t match, a query.", @@ -5516,7 +5516,7 @@ "/_field_caps": { "get": { "tags": [ - "field_caps" + "search" ], "summary": "The field capabilities API returns the information about the capabilities of fields among multiple indices", "description": "The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type\nof keyword is returned as any other field that belongs to the `keyword` family.", @@ -5559,7 +5559,7 @@ }, "post": { "tags": [ - "field_caps" + "search" ], "summary": "The field capabilities API returns the information about the capabilities of fields among multiple indices", "description": "The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type\nof keyword is returned as any other field that belongs to the `keyword` family.", @@ -5604,7 +5604,7 @@ "/{index}/_field_caps": { "get": { "tags": [ - "field_caps" + "search" ], "summary": "The field capabilities API returns the information about the capabilities of fields among multiple indices", "description": "The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type\nof keyword is returned as any other field that belongs to the `keyword` family.", @@ -5650,7 +5650,7 @@ }, "post": { "tags": [ - "field_caps" + "search" ], "summary": "The field capabilities API returns the information about the capabilities of fields among multiple indices", "description": "The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type\nof keyword is returned as any other field that belongs to the `keyword` family.", @@ -5752,7 +5752,7 @@ "/{index}/_doc": { "post": { "tags": [ - "index" + "document" ], "summary": "Index a document", "description": "Adds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", @@ -6391,7 +6391,7 @@ "/_data_stream/{name}": { "get": { "tags": [ - "indices" + "data stream" ], "summary": "Get data streams", "description": "Retrieves information about one or more data streams.", @@ -6776,7 +6776,7 @@ "/_data_stream/{name}/_lifecycle": { "get": { "tags": [ - "indices" + "data stream" ], "summary": "Get data stream lifecycles", "description": "Retrieves the data stream lifecycle configuration of one or more data streams.", @@ -7375,7 +7375,7 @@ "/_data_stream": { "get": { "tags": [ - "indices" + "data stream" ], "summary": "Get data streams", "description": "Retrieves information about one or more data streams.", @@ -7825,7 +7825,7 @@ "/_data_stream/_migrate/{name}": { "post": { "tags": [ - "indices" + "data stream" ], "summary": "Convert an index alias to a data stream", "description": "Converts an index alias to a data stream.\nYou must have a matching index template that is data stream enabled.\nThe alias must meet the following criteria:\nThe alias must have a write index;\nAll indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type;\nThe alias must not have any filters;\nThe alias must not use custom routing.\nIf successful, the request removes the alias and creates a data stream with the same name.\nThe indices for the alias become hidden backing indices for the stream.\nThe write index for the alias becomes the write index for the stream.", @@ -7881,7 +7881,7 @@ "/_data_stream/_modify": { "post": { "tags": [ - "indices" + "data stream" ], "summary": "Update data streams", "description": "Performs one or more data stream modification actions in a single atomic operation.", @@ -8949,7 +8949,7 @@ }, "head": { "tags": [ - "ping" + "cluster" ], "summary": "Ping the cluster", "description": "Returns whether the cluster is running.", @@ -14105,7 +14105,7 @@ "/_msearch/template": { "get": { "tags": [ - "msearch_template" + "search" ], "summary": "Runs multiple templated searches with a single request", "operationId": "msearch-template", @@ -14138,7 +14138,7 @@ }, "post": { "tags": [ - "msearch_template" + "search" ], "summary": "Runs multiple templated searches with a single request", "operationId": "msearch-template-1", @@ -14173,7 +14173,7 @@ "/{index}/_msearch/template": { "get": { "tags": [ - "msearch_template" + "search" ], "summary": "Runs multiple templated searches with a single request", "operationId": "msearch-template-2", @@ -14209,7 +14209,7 @@ }, "post": { "tags": [ - "msearch_template" + "search" ], "summary": "Runs multiple templated searches with a single request", "operationId": "msearch-template-3", @@ -14469,7 +14469,7 @@ "/{index}/_pit": { "post": { "tags": [ - "open_point_in_time" + "search" ], "summary": "A search request by default executes against the most recent visible data of the target indices,\n", "description": "which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the\nstate of the data as it existed when initiated. In some cases, it’s preferred to perform multiple\nsearch requests using the same point in time. For example, if refreshes happen between\n`search_after` requests, then the results of those requests might not be consistent as changes happening\nbetween searches are only visible to the more recent point in time.", @@ -14582,7 +14582,7 @@ "/_scripts/{id}/{context}": { "put": { "tags": [ - "put_script" + "script" ], "summary": "Create or update a script or search template", "description": "Creates or updates a stored script or search template.", @@ -14612,7 +14612,7 @@ }, "post": { "tags": [ - "put_script" + "script" ], "summary": "Create or update a script or search template", "description": "Creates or updates a stored script or search template.", @@ -15021,7 +15021,7 @@ "/_rank_eval": { "get": { "tags": [ - "rank_eval" + "search" ], "summary": "Enables you to evaluate the quality of ranked search results over a set of typical search queries", "operationId": "rank-eval", @@ -15051,7 +15051,7 @@ }, "post": { "tags": [ - "rank_eval" + "search" ], "summary": "Enables you to evaluate the quality of ranked search results over a set of typical search queries", "operationId": "rank-eval-1", @@ -15083,7 +15083,7 @@ "/{index}/_rank_eval": { "get": { "tags": [ - "rank_eval" + "search" ], "summary": "Enables you to evaluate the quality of ranked search results over a set of typical search queries", "operationId": "rank-eval-2", @@ -15116,7 +15116,7 @@ }, "post": { "tags": [ - "rank_eval" + "search" ], "summary": "Enables you to evaluate the quality of ranked search results over a set of typical search queries", "operationId": "rank-eval-3", @@ -15151,7 +15151,7 @@ "/_reindex": { "post": { "tags": [ - "reindex" + "document" ], "summary": "Reindex documents", "description": "Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself.", @@ -15344,7 +15344,7 @@ "/_render/template": { "get": { "tags": [ - "render_search_template" + "search" ], "summary": "Renders a search template as a search request body", "operationId": "render-search-template", @@ -15359,7 +15359,7 @@ }, "post": { "tags": [ - "render_search_template" + "search" ], "summary": "Renders a search template as a search request body", "operationId": "render-search-template-1", @@ -15376,7 +15376,7 @@ "/_render/template/{id}": { "get": { "tags": [ - "render_search_template" + "search" ], "summary": "Renders a search template as a search request body", "operationId": "render-search-template-2", @@ -15396,7 +15396,7 @@ }, "post": { "tags": [ - "render_search_template" + "search" ], "summary": "Renders a search template as a search request body", "operationId": "render-search-template-3", @@ -15418,7 +15418,7 @@ "/_scripts/painless/_execute": { "get": { "tags": [ - "scripts_painless_execute" + "script" ], "summary": "Run a script", "description": "Runs a script and returns a result.", @@ -15436,7 +15436,7 @@ }, "post": { "tags": [ - "scripts_painless_execute" + "script" ], "summary": "Run a script", "description": "Runs a script and returns a result.", @@ -16199,7 +16199,7 @@ "/_application/analytics/{name}": { "get": { "tags": [ - "search_application" + "analytics" ], "summary": "Get behavioral analytics collections", "operationId": "search-application-get-behavioral-analytics-1", @@ -16218,7 +16218,7 @@ }, "put": { "tags": [ - "search_application" + "analytics" ], "summary": "Create a behavioral analytics collection", "operationId": "search-application-put-behavioral-analytics", @@ -16252,7 +16252,7 @@ }, "delete": { "tags": [ - "search_application" + "analytics" ], "summary": "Delete a behavioral analytics collection", "description": "The associated data stream is also deleted.", @@ -16289,7 +16289,7 @@ "/_application/analytics": { "get": { "tags": [ - "search_application" + "analytics" ], "summary": "Get behavioral analytics collections", "operationId": "search-application-get-behavioral-analytics", @@ -16429,7 +16429,7 @@ "/{index}/_mvt/{field}/{zoom}/{x}/{y}": { "get": { "tags": [ - "search_mvt" + "search" ], "summary": "Search a vector tile", "description": "Searches a vector tile for geospatial values.", @@ -16484,7 +16484,7 @@ }, "post": { "tags": [ - "search_mvt" + "search" ], "summary": "Search a vector tile", "description": "Searches a vector tile for geospatial values.", @@ -16541,7 +16541,7 @@ "/_search/template": { "get": { "tags": [ - "search_template" + "search" ], "summary": "Runs a search with a search template", "operationId": "search-template", @@ -16598,7 +16598,7 @@ }, "post": { "tags": [ - "search_template" + "search" ], "summary": "Runs a search with a search template", "operationId": "search-template-1", @@ -16657,7 +16657,7 @@ "/{index}/_search/template": { "get": { "tags": [ - "search_template" + "search" ], "summary": "Runs a search with a search template", "operationId": "search-template-2", @@ -16717,7 +16717,7 @@ }, "post": { "tags": [ - "search_template" + "search" ], "summary": "Runs a search with a search template", "operationId": "search-template-3", @@ -18171,7 +18171,7 @@ "/{index}/_termvectors/{id}": { "get": { "tags": [ - "termvectors" + "document" ], "summary": "Get term vector information", "description": "Returns information and statistics about terms in the fields of a particular document.", @@ -18228,7 +18228,7 @@ }, "post": { "tags": [ - "termvectors" + "document" ], "summary": "Get term vector information", "description": "Returns information and statistics about terms in the fields of a particular document.", @@ -18287,7 +18287,7 @@ "/{index}/_termvectors": { "get": { "tags": [ - "termvectors" + "document" ], "summary": "Get term vector information", "description": "Returns information and statistics about terms in the fields of a particular document.", @@ -18341,7 +18341,7 @@ }, "post": { "tags": [ - "termvectors" + "document" ], "summary": "Get term vector information", "description": "Returns information and statistics about terms in the fields of a particular document.", @@ -19203,7 +19203,7 @@ "/{index}/_update/{id}": { "post": { "tags": [ - "update" + "document" ], "summary": "Update a document", "description": "Updates a document by running a script or passing a partial document.", @@ -19407,7 +19407,7 @@ "/{index}/_update_by_query": { "post": { "tags": [ - "update_by_query" + "document" ], "summary": "Update documents", "description": "Updates documents that match the specified query.\nIf no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes.", diff --git a/output/schema/schema.json b/output/schema/schema.json index d869bf3b2f..baab4ca7d2 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -173,6 +173,7 @@ }, "description": "Deletes an async search by identifier.\nIf the search is still running, the search request will be cancelled.\nOtherwise, the saved search results are deleted.\nIf the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.", "docId": "async-search", + "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/async-search.html", "name": "async_search.delete", "request": { @@ -209,6 +210,7 @@ }, "description": "Retrieves the results of a previously submitted async search request given its identifier.\nIf the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.", "docId": "async-search", + "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/async-search.html", "name": "async_search.get", "request": { @@ -245,6 +247,7 @@ }, "description": "Get async search status\nRetrieves the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", "docId": "async-search", + "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/async-search.html", "name": "async_search.status", "request": { @@ -281,6 +284,7 @@ }, "description": "Runs a search request asynchronously.\nWhen the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.\nWarning: Async search does not support scroll nor search requests that only include the suggest section.\nBy default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", "docId": "async-search", + "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/async-search.html", "name": "async_search.submit", "request": { @@ -456,6 +460,7 @@ }, "description": "Bulk index or delete documents.\nPerforms multiple indexing or delete operations in a single API call.\nThis reduces overhead and can greatly increase indexing speed.", "docId": "docs-bulk", + "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-bulk.html", "name": "bulk", "request": { @@ -2144,6 +2149,7 @@ }, "description": "Clears the search context and results for a scrolling search.", "docId": "clear-scroll-api", + "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/clear-scroll-api.html", "name": "clear_scroll", "request": { @@ -2194,6 +2200,7 @@ }, "description": "Closes a point-in-time.", "docId": "point-in-time-api", + "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/point-in-time-api.html", "name": "close_point_in_time", "request": { @@ -2273,6 +2280,7 @@ }, "description": "Delete component templates.\nDeletes component templates.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.", "docId": "indices-component-template", + "docTag": "indices", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-component-template.html", "name": "cluster.delete_component_template", "privileges": { @@ -2346,6 +2354,7 @@ }, "description": "Check component templates.\nReturns information about whether a particular component template exists.", "docId": "indices-component-template", + "docTag": "indices", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-component-template.html", "name": "cluster.exists_component_template", "request": { @@ -2382,6 +2391,7 @@ }, "description": "Get component templates.\nRetrieves information about component templates.", "docId": "indices-component-template", + "docTag": "indices", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-component-template.html", "name": "cluster.get_component_template", "privileges": { @@ -2469,6 +2479,7 @@ }, "description": "The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.\nThe cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status.", "docId": "cluster-health", + "docTag": "cluster", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-health.html", "name": "cluster.health", "privileges": { @@ -2625,6 +2636,7 @@ }, "description": "Create or update a component template.\nCreates or updates a component template.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nAn index template can be composed of multiple component templates.\nTo use a component template, specify it in an index template’s `composed_of` list.\nComponent templates are only applied to new data streams and indices as part of a matching index template.\n\nSettings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.\n\nComponent templates are only used during index creation.\nFor data streams, this includes data stream creation and the creation of a stream’s backing indices.\nChanges to component templates do not affect existing indices, including a stream’s backing indices.\n\nYou can use C-style `/* *\\/` block comments in component templates.\nYou can include comments anywhere in the request body except before the opening curly bracket.", "docId": "indices-component-template", + "docTag": "indices", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-component-template.html", "name": "cluster.put_component_template", "privileges": { @@ -4073,6 +4085,7 @@ } }, "description": "Returns number of documents matching a query.", + "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html", "name": "count", "request": { @@ -4119,6 +4132,7 @@ } }, "description": "Index a document.\nAdds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", + "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html", "name": "create", "request": { @@ -4250,6 +4264,7 @@ } }, "description": "Delete a document.\nRemoves a JSON document from the specified index.", + "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html", "name": "delete", "request": { @@ -4285,6 +4300,7 @@ } }, "description": "Delete documents.\nDeletes documents that match the specified query.", + "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html", "name": "delete_by_query", "request": { @@ -4357,6 +4373,7 @@ } }, "description": "Delete a script or search template.\nDeletes a stored script or search template.", + "docTag": "script", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", "name": "delete_script", "request": { @@ -4811,6 +4828,7 @@ } }, "description": "Check a document.\nChecks if a specified document exists.", + "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", "name": "exists", "request": { @@ -4846,6 +4864,7 @@ } }, "description": "Check for a document source.\nChecks if a document's `_source` is stored.", + "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", "name": "exists_source", "request": { @@ -4880,6 +4899,7 @@ } }, "description": "Explain a document match result.\nReturns information about why a specific document matches, or doesn’t match, a query.", + "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html", "name": "explain", "request": { @@ -4985,6 +5005,7 @@ } }, "description": "The field capabilities API returns the information about the capabilities of fields among multiple indices.\nThe field capabilities API returns runtime fields like any other field. For example, a runtime field with a type\nof keyword is returned as any other field that belongs to the `keyword` family.", + "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html", "name": "field_caps", "privileges": { @@ -5245,6 +5266,7 @@ } }, "description": "Get a document by its ID.\nRetrieves the document with the specified ID from an index.", + "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", "name": "get", "request": { @@ -5279,6 +5301,7 @@ } }, "description": "Get a script or search template.\nRetrieves a stored script or search template.", + "docTag": "script", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", "name": "get_script", "request": { @@ -5373,6 +5396,7 @@ } }, "description": "Get a document's source.\nReturns the source of a document.", + "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html", "name": "get_source", "request": { @@ -5868,6 +5892,7 @@ } }, "description": "Index a document.\nAdds a JSON document to the specified data stream or index and makes it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.", + "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html", "name": "index", "request": { @@ -6189,6 +6214,7 @@ } }, "description": "Get data stream stats.\nRetrieves statistics for one or more data streams.", + "docTag": "data stream", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.data_streams_stats", "privileges": { @@ -6925,6 +6951,7 @@ } }, "description": "Get data stream lifecycles.\nRetrieves the data stream lifecycle configuration of one or more data streams.", + "docTag": "data stream", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-get-lifecycle.html", "name": "indices.get_data_lifecycle", "request": { @@ -6960,6 +6987,7 @@ } }, "description": "Get data streams.\nRetrieves information about one or more data streams.", + "docTag": "data stream", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.get_data_stream", "privileges": { @@ -7224,6 +7252,7 @@ } }, "description": "Convert an index alias to a data stream.\nConverts an index alias to a data stream.\nYou must have a matching index template that is data stream enabled.\nThe alias must meet the following criteria:\nThe alias must have a write index;\nAll indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type;\nThe alias must not have any filters;\nThe alias must not use custom routing.\nIf successful, the request removes the alias and creates a data stream with the same name.\nThe indices for the alias become hidden backing indices for the stream.\nThe write index for the alias becomes the write index for the stream.", + "docTag": "data stream", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.migrate_to_data_stream", "privileges": { @@ -7264,6 +7293,7 @@ } }, "description": "Update data streams.\nPerforms one or more data stream modification actions in a single atomic operation.", + "docTag": "data stream", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.modify_data_stream", "request": { @@ -8806,6 +8836,7 @@ "version": "8.4.0" }, "description": "Performs a kNN search.", + "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html", "name": "knn_search", "request": { @@ -12682,6 +12713,7 @@ } }, "description": "Runs multiple templated searches with a single request.", + "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html", "name": "msearch_template", "privileges": { @@ -12778,6 +12810,7 @@ } }, "description": "You can use this API to clear the archived repositories metering information in the cluster.", + "docTag": "cluster", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-repositories-metering-archive-api.html", "name": "nodes.clear_repositories_metering_archive", "privileges": { @@ -12819,6 +12852,7 @@ } }, "description": "You can use the cluster repositories metering API to retrieve repositories metering information in a cluster.\nThis API exposes monotonically non-decreasing counters and it’s expected that clients would durably store the\ninformation needed to compute aggregations over a period of time. Additionally, the information exposed by this\nAPI is volatile, meaning that it won’t be present after node restarts.", + "docTag": "cluster", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-repositories-metering-api.html", "name": "nodes.get_repositories_metering_info", "privileges": { @@ -12860,6 +12894,7 @@ }, "description": "This API yields a breakdown of the hot threads on each selected node in the cluster.\nThe output is plain text with a breakdown of each node’s top hot threads.", "docId": "cluster-nodes-hot-threads", + "docTag": "cluster", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-hot-threads.html", "name": "nodes.hot_threads", "privileges": { @@ -12908,6 +12943,7 @@ }, "description": "Returns cluster nodes information.", "docId": "cluster-nodes-info", + "docTag": "cluster", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-info.html", "name": "nodes.info", "request": { @@ -12957,6 +12993,7 @@ } }, "description": "Reloads the keystore on nodes in the cluster.", + "docTag": "cluster", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/secure-settings.html#reloadable-secure-settings", "name": "nodes.reload_secure_settings", "request": { @@ -13001,6 +13038,7 @@ }, "description": "Returns cluster nodes statistics.", "docId": "cluster-nodes-stats", + "docTag": "cluster", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-stats.html", "name": "nodes.stats", "privileges": { @@ -13073,6 +13111,7 @@ }, "description": "Returns information on the usage of features.", "docId": "cluster-nodes-usage", + "docTag": "cluster", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-usage.html", "name": "nodes.usage", "privileges": { @@ -13133,6 +13172,7 @@ }, "description": "A search request by default executes against the most recent visible data of the target indices,\nwhich is called point in time. Elasticsearch pit (point in time) is a lightweight view into the\nstate of the data as it existed when initiated. In some cases, it’s preferred to perform multiple\nsearch requests using the same point in time. For example, if refreshes happen between\n`search_after` requests, then the results of those requests might not be consistent as changes happening\nbetween searches are only visible to the more recent point in time.", "docId": "point-in-time-api", + "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/point-in-time-api.html", "name": "open_point_in_time", "privileges": { @@ -13175,6 +13215,7 @@ } }, "description": "Ping the cluster.\nReturns whether the cluster is running.", + "docTag": "cluster", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html", "name": "ping", "request": { @@ -13318,6 +13359,7 @@ } }, "description": "Create or update a script or search template.\nCreates or updates a stored script or search template.", + "docTag": "script", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html", "name": "put_script", "request": { @@ -13615,6 +13657,7 @@ } }, "description": "Enables you to evaluate the quality of ranked search results over a set of typical search queries.", + "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-rank-eval.html", "name": "rank_eval", "privileges": { @@ -13666,6 +13709,7 @@ } }, "description": "Reindex documents.\nCopies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself.", + "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html", "name": "reindex", "request": { @@ -13704,6 +13748,7 @@ } }, "description": "Copies documents from a source to a destination.", + "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-reindex.html", "name": "reindex_rethrottle", "request": { @@ -13738,6 +13783,7 @@ } }, "description": "Renders a search template as a search request body.", + "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/render-search-template-api.html", "name": "render_search_template", "request": { @@ -14057,6 +14103,7 @@ } }, "description": "Run a script.\nRuns a script and returns a result.", + "docTag": "script", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-api.html", "name": "scripts_painless_execute", "request": { @@ -14230,6 +14277,7 @@ } }, "description": "Delete a behavioral analytics collection.\nThe associated data stream is also deleted.", + "docTag": "analytics", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-analytics-collection.html", "name": "search_application.delete_behavioral_analytics", "request": { @@ -14300,6 +14348,7 @@ } }, "description": "Get behavioral analytics collections.", + "docTag": "analytics", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-analytics-collection.html", "name": "search_application.get_behavioral_analytics", "request": { @@ -14442,6 +14491,7 @@ } }, "description": "Create a behavioral analytics collection.", + "docTag": "analytics", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-analytics-collection.html", "name": "search_application.put_behavioral_analytics", "request": { @@ -14544,6 +14594,7 @@ } }, "description": "Search a vector tile.\nSearches a vector tile for geospatial values.", + "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-vector-tile-api.html", "name": "search_mvt", "request": { @@ -14578,6 +14629,7 @@ } }, "description": "Returns information about the indices and shards that a search request would be executed against.", + "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-shards.html", "name": "search_shards", "request": { @@ -14621,6 +14673,7 @@ } }, "description": "Runs a search with a search template.", + "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html", "name": "search_template", "request": { @@ -18808,6 +18861,7 @@ } }, "description": "Get term vector information.\nReturns information and statistics about terms in the fields of a particular document.", + "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html", "name": "termvectors", "request": { @@ -19501,6 +19555,7 @@ } }, "description": "Update a document.\nUpdates a document by running a script or passing a partial document.", + "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html", "name": "update", "request": { @@ -19539,6 +19594,7 @@ } }, "description": "Update documents.\nUpdates documents that match the specified query.\nIf no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes.", + "docTag": "document", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html", "name": "update_by_query", "request": { @@ -20532,7 +20588,7 @@ } } ], - "specLocation": "_global/bulk/BulkRequest.ts#L32-L104" + "specLocation": "_global/bulk/BulkRequest.ts#L32-L105" }, { "kind": "response", @@ -21033,7 +21089,7 @@ } ], "query": [], - "specLocation": "_global/clear_scroll/ClearScrollRequest.ts#L23-L45" + "specLocation": "_global/clear_scroll/ClearScrollRequest.ts#L23-L46" }, { "kind": "response", @@ -21139,7 +21195,7 @@ }, "path": [], "query": [], - "specLocation": "_global/close_point_in_time/ClosePointInTimeRequest.ts#L23-L37" + "specLocation": "_global/close_point_in_time/ClosePointInTimeRequest.ts#L23-L38" }, { "kind": "response", @@ -21433,7 +21489,7 @@ } } ], - "specLocation": "_global/count/CountRequest.ts#L26-L120" + "specLocation": "_global/count/CountRequest.ts#L26-L121" }, { "kind": "response", @@ -21784,7 +21840,7 @@ } } ], - "specLocation": "_global/delete/DeleteRequest.ts#L34-L92" + "specLocation": "_global/delete/DeleteRequest.ts#L34-L93" }, { "kind": "response", @@ -22274,7 +22330,7 @@ } } ], - "specLocation": "_global/delete_by_query/DeleteByQueryRequest.ts#L36-L210" + "specLocation": "_global/delete_by_query/DeleteByQueryRequest.ts#L36-L211" }, { "kind": "response", @@ -22623,7 +22679,7 @@ } } ], - "specLocation": "_global/delete_script/DeleteScriptRequest.ts#L24-L52" + "specLocation": "_global/delete_script/DeleteScriptRequest.ts#L24-L53" }, { "kind": "response", @@ -22816,7 +22872,7 @@ } } ], - "specLocation": "_global/exists/DocumentExistsRequest.ts#L31-L100" + "specLocation": "_global/exists/DocumentExistsRequest.ts#L31-L101" }, { "kind": "response", @@ -22990,7 +23046,7 @@ } } ], - "specLocation": "_global/exists_source/SourceExistsRequest.ts#L31-L94" + "specLocation": "_global/exists_source/SourceExistsRequest.ts#L31-L95" }, { "kind": "response", @@ -23303,7 +23359,7 @@ } } ], - "specLocation": "_global/explain/ExplainRequest.ts#L26-L106" + "specLocation": "_global/explain/ExplainRequest.ts#L26-L107" }, { "kind": "response", @@ -23794,7 +23850,7 @@ } } ], - "specLocation": "_global/field_caps/FieldCapabilitiesRequest.ts#L25-L106" + "specLocation": "_global/field_caps/FieldCapabilitiesRequest.ts#L25-L107" }, { "kind": "response", @@ -24181,7 +24237,7 @@ } } ], - "specLocation": "_global/get/GetRequest.ts#L31-L100" + "specLocation": "_global/get/GetRequest.ts#L31-L101" }, { "kind": "response", @@ -24301,7 +24357,7 @@ } } ], - "specLocation": "_global/get_script/GetScriptRequest.ts#L24-L42" + "specLocation": "_global/get_script/GetScriptRequest.ts#L24-L43" }, { "kind": "response", @@ -24782,7 +24838,7 @@ } } ], - "specLocation": "_global/get_source/SourceRequest.ts#L31-L88" + "specLocation": "_global/get_source/SourceRequest.ts#L31-L89" }, { "kind": "response", @@ -26469,7 +26525,7 @@ } } ], - "specLocation": "_global/index/IndexRequest.ts#L35-L118" + "specLocation": "_global/index/IndexRequest.ts#L35-L119" }, { "kind": "response", @@ -26729,7 +26785,7 @@ } } ], - "specLocation": "_global/knn_search/KnnSearchRequest.ts#L26-L79" + "specLocation": "_global/knn_search/KnnSearchRequest.ts#L26-L80" }, { "kind": "response", @@ -28436,7 +28492,7 @@ } } ], - "specLocation": "_global/msearch_template/MultiSearchTemplateRequest.ts#L25-L70" + "specLocation": "_global/msearch_template/MultiSearchTemplateRequest.ts#L25-L71" }, { "kind": "type_alias", @@ -29208,7 +29264,7 @@ } } ], - "specLocation": "_global/open_point_in_time/OpenPointInTimeRequest.ts#L25-L75" + "specLocation": "_global/open_point_in_time/OpenPointInTimeRequest.ts#L25-L76" }, { "kind": "response", @@ -29267,7 +29323,7 @@ }, "path": [], "query": [], - "specLocation": "_global/ping/PingRequest.ts#L22-L29" + "specLocation": "_global/ping/PingRequest.ts#L22-L30" }, { "kind": "response", @@ -29367,7 +29423,7 @@ } } ], - "specLocation": "_global/put_script/PutScriptRequest.ts#L25-L65" + "specLocation": "_global/put_script/PutScriptRequest.ts#L25-L66" }, { "kind": "response", @@ -30078,7 +30134,7 @@ } } ], - "specLocation": "_global/rank_eval/RankEvalRequest.ts#L24-L61" + "specLocation": "_global/rank_eval/RankEvalRequest.ts#L24-L62" }, { "kind": "response", @@ -30542,7 +30598,7 @@ } } ], - "specLocation": "_global/reindex/ReindexRequest.ts#L27-L103" + "specLocation": "_global/reindex/ReindexRequest.ts#L27-L104" }, { "kind": "response", @@ -31274,7 +31330,7 @@ } } ], - "specLocation": "_global/reindex_rethrottle/ReindexRethrottleRequest.ts#L24-L43" + "specLocation": "_global/reindex_rethrottle/ReindexRethrottleRequest.ts#L24-L44" }, { "kind": "response", @@ -31389,7 +31445,7 @@ } ], "query": [], - "specLocation": "_global/render_search_template/RenderSearchTemplateRequest.ts#L25-L55" + "specLocation": "_global/render_search_template/RenderSearchTemplateRequest.ts#L25-L56" }, { "kind": "response", @@ -31524,7 +31580,7 @@ }, "path": [], "query": [], - "specLocation": "_global/scripts_painless_execute/ExecutePainlessScriptRequest.ts#L24-L47" + "specLocation": "_global/scripts_painless_execute/ExecutePainlessScriptRequest.ts#L24-L48" }, { "kind": "response", @@ -39071,7 +39127,7 @@ } } ], - "specLocation": "_global/search_mvt/SearchMvtRequest.ts#L33-L190" + "specLocation": "_global/search_mvt/SearchMvtRequest.ts#L33-L192" }, { "kind": "response", @@ -39273,7 +39329,7 @@ } } ], - "specLocation": "_global/search_shards/SearchShardsRequest.ts#L23-L70" + "specLocation": "_global/search_shards/SearchShardsRequest.ts#L23-L71" }, { "kind": "response", @@ -39790,7 +39846,7 @@ } } ], - "specLocation": "_global/search_template/SearchTemplateRequest.ts#L32-L134" + "specLocation": "_global/search_template/SearchTemplateRequest.ts#L32-L135" }, { "kind": "response", @@ -40574,7 +40630,7 @@ } } ], - "specLocation": "_global/termvectors/TermVectorsRequest.ts#L33-L120" + "specLocation": "_global/termvectors/TermVectorsRequest.ts#L33-L121" }, { "kind": "response", @@ -41129,7 +41185,7 @@ } } ], - "specLocation": "_global/update/UpdateRequest.ts#L38-L153" + "specLocation": "_global/update/UpdateRequest.ts#L38-L154" }, { "kind": "response", @@ -41695,7 +41751,7 @@ } } ], - "specLocation": "_global/update_by_query/UpdateByQueryRequest.ts#L37-L226" + "specLocation": "_global/update_by_query/UpdateByQueryRequest.ts#L37-L227" }, { "kind": "response", @@ -86497,7 +86553,7 @@ } ], "query": [], - "specLocation": "async_search/delete/AsyncSearchDeleteRequest.ts#L23-L38" + "specLocation": "async_search/delete/AsyncSearchDeleteRequest.ts#L23-L39" }, { "kind": "response", @@ -86588,7 +86644,7 @@ } } ], - "specLocation": "async_search/get/AsyncSearchGetRequest.ts#L24-L54" + "specLocation": "async_search/get/AsyncSearchGetRequest.ts#L24-L55" }, { "kind": "response", @@ -86657,7 +86713,7 @@ } ], "query": [], - "specLocation": "async_search/status/AsyncSearchStatusRequest.ts#L23-L37" + "specLocation": "async_search/status/AsyncSearchStatusRequest.ts#L23-L38" }, { "kind": "response", @@ -87813,7 +87869,7 @@ } } ], - "specLocation": "async_search/submit/AsyncSearchSubmitRequest.ts#L55-L286" + "specLocation": "async_search/submit/AsyncSearchSubmitRequest.ts#L55-L287" }, { "kind": "response", @@ -105488,7 +105544,7 @@ } } ], - "specLocation": "cluster/delete_component_template/ClusterDeleteComponentTemplateRequest.ts#L24-L55" + "specLocation": "cluster/delete_component_template/ClusterDeleteComponentTemplateRequest.ts#L24-L56" }, { "kind": "response", @@ -105617,7 +105673,7 @@ } } ], - "specLocation": "cluster/exists_component_template/ClusterComponentTemplateExistsRequest.ts#L24-L55" + "specLocation": "cluster/exists_component_template/ClusterComponentTemplateExistsRequest.ts#L24-L56" }, { "kind": "response", @@ -105726,7 +105782,7 @@ } } ], - "specLocation": "cluster/get_component_template/ClusterGetComponentTemplateRequest.ts#L24-L66" + "specLocation": "cluster/get_component_template/ClusterGetComponentTemplateRequest.ts#L24-L67" }, { "kind": "response", @@ -106459,7 +106515,7 @@ } } ], - "specLocation": "cluster/health/ClusterHealthRequest.ts#L32-L98" + "specLocation": "cluster/health/ClusterHealthRequest.ts#L32-L99" }, { "kind": "response", @@ -107049,7 +107105,7 @@ } } ], - "specLocation": "cluster/put_component_template/ClusterPutComponentTemplateRequest.ts#L25-L94" + "specLocation": "cluster/put_component_template/ClusterPutComponentTemplateRequest.ts#L25-L95" }, { "kind": "response", @@ -128065,7 +128121,7 @@ } } ], - "specLocation": "indices/data_streams_stats/IndicesDataStreamsStatsRequest.ts#L23-L48" + "specLocation": "indices/data_streams_stats/IndicesDataStreamsStatsRequest.ts#L23-L49" }, { "kind": "response", @@ -130813,7 +130869,7 @@ } } ], - "specLocation": "indices/get_data_lifecycle/IndicesGetDataLifecycleRequest.ts#L24-L59" + "specLocation": "indices/get_data_lifecycle/IndicesGetDataLifecycleRequest.ts#L24-L60" }, { "kind": "response", @@ -130938,7 +130994,7 @@ } } ], - "specLocation": "indices/get_data_stream/IndicesGetDataStreamRequest.ts#L24-L65" + "specLocation": "indices/get_data_stream/IndicesGetDataStreamRequest.ts#L24-L66" }, { "kind": "response", @@ -131797,7 +131853,7 @@ } } ], - "specLocation": "indices/migrate_to_data_stream/IndicesMigrateToDataStreamRequest.ts#L24-L58" + "specLocation": "indices/migrate_to_data_stream/IndicesMigrateToDataStreamRequest.ts#L24-L59" }, { "kind": "response", @@ -131926,7 +131982,7 @@ }, "path": [], "query": [], - "specLocation": "indices/modify_data_stream/IndicesModifyDataStreamRequest.ts#L23-L37" + "specLocation": "indices/modify_data_stream/IndicesModifyDataStreamRequest.ts#L23-L38" }, { "kind": "response", @@ -177078,7 +177134,7 @@ } ], "query": [], - "specLocation": "nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveRequest.ts#L24-L43" + "specLocation": "nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveRequest.ts#L24-L44" }, { "kind": "response", @@ -177183,7 +177239,7 @@ } ], "query": [], - "specLocation": "nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoRequest.ts#L23-L41" + "specLocation": "nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoRequest.ts#L23-L42" }, { "kind": "response", @@ -177392,7 +177448,7 @@ } } ], - "specLocation": "nodes/hot_threads/NodesHotThreadsRequest.ts#L25-L83" + "specLocation": "nodes/hot_threads/NodesHotThreadsRequest.ts#L25-L84" }, { "kind": "response", @@ -180404,7 +180460,7 @@ } } ], - "specLocation": "nodes/info/NodesInfoRequest.ts#L24-L55" + "specLocation": "nodes/info/NodesInfoRequest.ts#L24-L56" }, { "kind": "response", @@ -180535,7 +180591,7 @@ } } ], - "specLocation": "nodes/reload_secure_settings/ReloadSecureSettingsRequest.ts#L24-L50" + "specLocation": "nodes/reload_secure_settings/ReloadSecureSettingsRequest.ts#L24-L51" }, { "kind": "response", @@ -180790,7 +180846,7 @@ } } ], - "specLocation": "nodes/stats/NodesStatsRequest.ts#L24-L75" + "specLocation": "nodes/stats/NodesStatsRequest.ts#L24-L76" }, { "kind": "response", @@ -181009,7 +181065,7 @@ } } ], - "specLocation": "nodes/usage/NodesUsageRequest.ts#L24-L49" + "specLocation": "nodes/usage/NodesUsageRequest.ts#L24-L50" }, { "kind": "response", @@ -183881,7 +183937,7 @@ } ], "query": [], - "specLocation": "search_application/delete_behavioral_analytics/BehavioralAnalyticsDeleteRequest.ts#L22-L36" + "specLocation": "search_application/delete_behavioral_analytics/BehavioralAnalyticsDeleteRequest.ts#L22-L37" }, { "kind": "response", @@ -183992,7 +184048,7 @@ } ], "query": [], - "specLocation": "search_application/get_behavioral_analytics/BehavioralAnalyticsGetRequest.ts#L22-L35" + "specLocation": "search_application/get_behavioral_analytics/BehavioralAnalyticsGetRequest.ts#L22-L36" }, { "kind": "response", @@ -184336,7 +184392,7 @@ } ], "query": [], - "specLocation": "search_application/put_behavioral_analytics/BehavioralAnalyticsPutRequest.ts#L22-L35" + "specLocation": "search_application/put_behavioral_analytics/BehavioralAnalyticsPutRequest.ts#L22-L36" }, { "kind": "response", diff --git a/specification/_global/bulk/BulkRequest.ts b/specification/_global/bulk/BulkRequest.ts index 6814dd46ff..048e77289f 100644 --- a/specification/_global/bulk/BulkRequest.ts +++ b/specification/_global/bulk/BulkRequest.ts @@ -37,6 +37,7 @@ import { OperationContainer, UpdateAction } from './types' * @availability stack stability=stable * @availability serverless stability=stable visibility=public * @doc_id docs-bulk + * @doc_tag document * */ export interface Request extends RequestBase { diff --git a/specification/_global/clear_scroll/ClearScrollRequest.ts b/specification/_global/clear_scroll/ClearScrollRequest.ts index 97c7d24735..570721ba42 100644 --- a/specification/_global/clear_scroll/ClearScrollRequest.ts +++ b/specification/_global/clear_scroll/ClearScrollRequest.ts @@ -26,6 +26,7 @@ import { ScrollIds } from '@_types/common' * @availability stack stability=stable * @availability serverless stability=stable visibility=public * @doc_id clear-scroll-api + * @doc_tag search */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/_global/close_point_in_time/ClosePointInTimeRequest.ts b/specification/_global/close_point_in_time/ClosePointInTimeRequest.ts index e37a6e0de1..5f9f66ee79 100644 --- a/specification/_global/close_point_in_time/ClosePointInTimeRequest.ts +++ b/specification/_global/close_point_in_time/ClosePointInTimeRequest.ts @@ -26,6 +26,7 @@ import { Id } from '@_types/common' * @availability stack since=7.10.0 stability=stable * @availability serverless stability=stable visibility=public * @doc_id point-in-time-api + * @doc_tag search */ export interface Request extends RequestBase { body: { diff --git a/specification/_global/count/CountRequest.ts b/specification/_global/count/CountRequest.ts index 1bebd0c980..b6f5ccefad 100644 --- a/specification/_global/count/CountRequest.ts +++ b/specification/_global/count/CountRequest.ts @@ -27,6 +27,7 @@ import { Operator } from '@_types/query_dsl/Operator' * @rest_spec_name count * @availability stack stability=stable * @availability serverless stability=stable visibility=public + * @doc_tag search */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/_global/create/CreateRequest.ts b/specification/_global/create/CreateRequest.ts index 5da39bc552..7ccb45e1ef 100644 --- a/specification/_global/create/CreateRequest.ts +++ b/specification/_global/create/CreateRequest.ts @@ -36,7 +36,7 @@ import { Duration } from '@_types/Time' * @rest_spec_name create * @availability stack since=5.0.0 stability=stable * @availability serverless stability=stable visibility=public - * + * @doc_tag document */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/_global/delete/DeleteRequest.ts b/specification/_global/delete/DeleteRequest.ts index d07b026033..bef0fdd14b 100644 --- a/specification/_global/delete/DeleteRequest.ts +++ b/specification/_global/delete/DeleteRequest.ts @@ -37,6 +37,7 @@ import { Duration } from '@_types/Time' * @rest_spec_name delete * @availability stack stability=stable * @availability serverless stability=stable visibility=public + * @doc_tag document */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/_global/delete_by_query/DeleteByQueryRequest.ts b/specification/_global/delete_by_query/DeleteByQueryRequest.ts index d1691e6f19..bdf6f7f94a 100644 --- a/specification/_global/delete_by_query/DeleteByQueryRequest.ts +++ b/specification/_global/delete_by_query/DeleteByQueryRequest.ts @@ -39,6 +39,7 @@ import { Duration } from '@_types/Time' * @rest_spec_name delete_by_query * @availability stack since=5.0.0 stability=stable * @availability serverless stability=stable visibility=public + * @doc_tag document */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/_global/delete_script/DeleteScriptRequest.ts b/specification/_global/delete_script/DeleteScriptRequest.ts index 209450bfab..bebddde62e 100644 --- a/specification/_global/delete_script/DeleteScriptRequest.ts +++ b/specification/_global/delete_script/DeleteScriptRequest.ts @@ -27,6 +27,7 @@ import { Duration } from '@_types/Time' * @rest_spec_name delete_script * @availability stack stability=stable * @availability serverless stability=stable visibility=public + * @doc_tag script */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/_global/exists/DocumentExistsRequest.ts b/specification/_global/exists/DocumentExistsRequest.ts index 8908bb9fbd..836d75e961 100644 --- a/specification/_global/exists/DocumentExistsRequest.ts +++ b/specification/_global/exists/DocumentExistsRequest.ts @@ -34,6 +34,7 @@ import { * @rest_spec_name exists * @availability stack stability=stable * @availability serverless stability=stable visibility=public + * @doc_tag document */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/_global/exists_source/SourceExistsRequest.ts b/specification/_global/exists_source/SourceExistsRequest.ts index 41755a033b..304dc6a20e 100644 --- a/specification/_global/exists_source/SourceExistsRequest.ts +++ b/specification/_global/exists_source/SourceExistsRequest.ts @@ -34,6 +34,7 @@ import { * @rest_spec_name exists_source * @availability stack since=5.4.0 stability=stable * @availability serverless stability=stable visibility=public + * @doc_tag document */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/_global/explain/ExplainRequest.ts b/specification/_global/explain/ExplainRequest.ts index 99874b0621..a17246cc3a 100644 --- a/specification/_global/explain/ExplainRequest.ts +++ b/specification/_global/explain/ExplainRequest.ts @@ -29,6 +29,7 @@ import { Operator } from '@_types/query_dsl/Operator' * @rest_spec_name explain * @availability stack stability=stable * @availability serverless stability=stable visibility=public + * @doc_tag search */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/_global/field_caps/FieldCapabilitiesRequest.ts b/specification/_global/field_caps/FieldCapabilitiesRequest.ts index 5952cfb181..98a430ab1b 100644 --- a/specification/_global/field_caps/FieldCapabilitiesRequest.ts +++ b/specification/_global/field_caps/FieldCapabilitiesRequest.ts @@ -30,6 +30,7 @@ import { QueryContainer } from '@_types/query_dsl/abstractions' * @availability stack since=5.4.0 stability=stable * @availability serverless stability=stable visibility=public * @index_privileges view_index_metadata,read,manage + * @doc_tag search */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/_global/get/GetRequest.ts b/specification/_global/get/GetRequest.ts index 51880fca0e..a54dec0b4a 100644 --- a/specification/_global/get/GetRequest.ts +++ b/specification/_global/get/GetRequest.ts @@ -34,6 +34,7 @@ import { * @rest_spec_name get * @availability stack stability=stable * @availability serverless stability=stable visibility=public + * @doc_tag document */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/_global/get_script/GetScriptRequest.ts b/specification/_global/get_script/GetScriptRequest.ts index 1384917aff..ee41e806f0 100644 --- a/specification/_global/get_script/GetScriptRequest.ts +++ b/specification/_global/get_script/GetScriptRequest.ts @@ -27,6 +27,7 @@ import { Duration } from '@_types/Time' * @rest_spec_name get_script * @availability stack stability=stable * @availability serverless stability=stable visibility=public + * @doc_tag script */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/_global/get_source/SourceRequest.ts b/specification/_global/get_source/SourceRequest.ts index 13f10fc493..9c2b305f6e 100644 --- a/specification/_global/get_source/SourceRequest.ts +++ b/specification/_global/get_source/SourceRequest.ts @@ -34,6 +34,7 @@ import { * @rest_spec_name get_source * @availability stack stability=stable * @availability serverless stability=stable visibility=public + * @doc_tag document */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/_global/index/IndexRequest.ts b/specification/_global/index/IndexRequest.ts index afdb4f3d83..1edb606b28 100644 --- a/specification/_global/index/IndexRequest.ts +++ b/specification/_global/index/IndexRequest.ts @@ -39,6 +39,7 @@ import { Duration } from '@_types/Time' * @rest_spec_name index * @availability stack stability=stable * @availability serverless stability=stable visibility=public + * @doc_tag document */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/_global/knn_search/KnnSearchRequest.ts b/specification/_global/knn_search/KnnSearchRequest.ts index 1fb3ee01c6..6f7117825b 100644 --- a/specification/_global/knn_search/KnnSearchRequest.ts +++ b/specification/_global/knn_search/KnnSearchRequest.ts @@ -27,6 +27,7 @@ import { Query } from './_types/Knn' * @rest_spec_name knn_search * @availability stack since=8.0.0 stability=experimental * @deprecated 8.4.0 + * @doc_tag search */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/_global/msearch_template/MultiSearchTemplateRequest.ts b/specification/_global/msearch_template/MultiSearchTemplateRequest.ts index e2ce4035e5..48fb5df389 100644 --- a/specification/_global/msearch_template/MultiSearchTemplateRequest.ts +++ b/specification/_global/msearch_template/MultiSearchTemplateRequest.ts @@ -28,6 +28,7 @@ import { RequestItem } from './types' * @availability stack since=5.0.0 stability=stable * @availability serverless stability=stable visibility=public * @index_privileges read + * @doc_tag search */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/_global/open_point_in_time/OpenPointInTimeRequest.ts b/specification/_global/open_point_in_time/OpenPointInTimeRequest.ts index fed2c52fba..f66605eb3a 100644 --- a/specification/_global/open_point_in_time/OpenPointInTimeRequest.ts +++ b/specification/_global/open_point_in_time/OpenPointInTimeRequest.ts @@ -34,6 +34,7 @@ import { Duration } from '@_types/Time' * @availability serverless stability=stable visibility=public * @doc_id point-in-time-api * @index_privileges read + * @doc_tag search */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/_global/ping/PingRequest.ts b/specification/_global/ping/PingRequest.ts index e8033036f5..42af1f4d01 100644 --- a/specification/_global/ping/PingRequest.ts +++ b/specification/_global/ping/PingRequest.ts @@ -25,5 +25,6 @@ import { RequestBase } from '@_types/Base' * @rest_spec_name ping * @availability stack stability=stable * @availability serverless stability=stable visibility=public + * @doc_tag cluster */ export interface Request extends RequestBase {} diff --git a/specification/_global/put_script/PutScriptRequest.ts b/specification/_global/put_script/PutScriptRequest.ts index 0119f68d18..f57c75862d 100644 --- a/specification/_global/put_script/PutScriptRequest.ts +++ b/specification/_global/put_script/PutScriptRequest.ts @@ -28,6 +28,7 @@ import { Duration } from '@_types/Time' * @rest_spec_name put_script * @availability stack stability=stable * @availability serverless stability=stable visibility=public + * @doc_tag script */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/_global/rank_eval/RankEvalRequest.ts b/specification/_global/rank_eval/RankEvalRequest.ts index c54fd59be2..563629ece6 100644 --- a/specification/_global/rank_eval/RankEvalRequest.ts +++ b/specification/_global/rank_eval/RankEvalRequest.ts @@ -27,6 +27,7 @@ import { RankEvalMetric, RankEvalRequestItem } from './types' * @availability stack since=6.2.0 stability=stable * @availability serverless stability=stable visibility=public * @index_privileges read + * @doc_tag search */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/_global/reindex/ReindexRequest.ts b/specification/_global/reindex/ReindexRequest.ts index 1e90c2845c..090942ad02 100644 --- a/specification/_global/reindex/ReindexRequest.ts +++ b/specification/_global/reindex/ReindexRequest.ts @@ -30,6 +30,7 @@ import { Destination, Source } from './types' * @rest_spec_name reindex * @availability stack since=2.3.0 stability=stable * @availability serverless stability=stable visibility=public + * @doc_tag document */ export interface Request extends RequestBase { query_parameters: { diff --git a/specification/_global/reindex_rethrottle/ReindexRethrottleRequest.ts b/specification/_global/reindex_rethrottle/ReindexRethrottleRequest.ts index 17be461f7f..e955a60dbc 100644 --- a/specification/_global/reindex_rethrottle/ReindexRethrottleRequest.ts +++ b/specification/_global/reindex_rethrottle/ReindexRethrottleRequest.ts @@ -26,6 +26,7 @@ import { float } from '@_types/Numeric' * @rest_spec_name reindex_rethrottle * @availability stack since=2.4.0 stability=stable * @availability serverless stability=stable visibility=private + * @doc_tag document */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/_global/render_search_template/RenderSearchTemplateRequest.ts b/specification/_global/render_search_template/RenderSearchTemplateRequest.ts index 4d4f923868..98213554d3 100644 --- a/specification/_global/render_search_template/RenderSearchTemplateRequest.ts +++ b/specification/_global/render_search_template/RenderSearchTemplateRequest.ts @@ -27,6 +27,7 @@ import { Id } from '@_types/common' * @rest_spec_name render_search_template * @availability stack stability=stable * @availability serverless stability=stable visibility=public + * @doc_tag search */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/_global/scripts_painless_execute/ExecutePainlessScriptRequest.ts b/specification/_global/scripts_painless_execute/ExecutePainlessScriptRequest.ts index 136542af78..070690f65a 100644 --- a/specification/_global/scripts_painless_execute/ExecutePainlessScriptRequest.ts +++ b/specification/_global/scripts_painless_execute/ExecutePainlessScriptRequest.ts @@ -27,6 +27,7 @@ import { PainlessContextSetup } from './types' * @rest_spec_name scripts_painless_execute * @availability stack since=6.3.0 stability=experimental * @availability serverless stability=experimental visibility=public + * @doc_tag script */ export interface Request extends RequestBase { body: { diff --git a/specification/_global/search_mvt/SearchMvtRequest.ts b/specification/_global/search_mvt/SearchMvtRequest.ts index 432e428e9c..9ec4803a7e 100644 --- a/specification/_global/search_mvt/SearchMvtRequest.ts +++ b/specification/_global/search_mvt/SearchMvtRequest.ts @@ -36,6 +36,8 @@ import { ZoomLevel } from './_types/ZoomLevel' * @rest_spec_name search_mvt * @availability stack since=7.15.0 stability=stable * @availability serverless stability=stable visibility=public + * @doc_tag search + * */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/_global/search_shards/SearchShardsRequest.ts b/specification/_global/search_shards/SearchShardsRequest.ts index c41937f824..ee3f985563 100644 --- a/specification/_global/search_shards/SearchShardsRequest.ts +++ b/specification/_global/search_shards/SearchShardsRequest.ts @@ -23,6 +23,7 @@ import { ExpandWildcards, Indices, Routing } from '@_types/common' /** * @rest_spec_name search_shards * @availability stack stability=stable + * @doc_tag search */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/_global/search_template/SearchTemplateRequest.ts b/specification/_global/search_template/SearchTemplateRequest.ts index 4d040db71f..f09e716501 100644 --- a/specification/_global/search_template/SearchTemplateRequest.ts +++ b/specification/_global/search_template/SearchTemplateRequest.ts @@ -34,6 +34,7 @@ import { Duration } from '@_types/Time' * @rest_spec_name search_template * @availability stack since=2.0.0 stability=stable * @availability serverless stability=stable visibility=public + * @doc_tag search */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/_global/termvectors/TermVectorsRequest.ts b/specification/_global/termvectors/TermVectorsRequest.ts index f0285d63c9..4f16e93562 100644 --- a/specification/_global/termvectors/TermVectorsRequest.ts +++ b/specification/_global/termvectors/TermVectorsRequest.ts @@ -36,6 +36,7 @@ import { Filter } from './types' * @rest_spec_name termvectors * @availability stack stability=stable * @availability serverless stability=stable visibility=public + * @doc_tag document */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/_global/update/UpdateRequest.ts b/specification/_global/update/UpdateRequest.ts index b969edb1c0..1f9ce904c8 100644 --- a/specification/_global/update/UpdateRequest.ts +++ b/specification/_global/update/UpdateRequest.ts @@ -41,6 +41,7 @@ import { Duration } from '@_types/Time' * @rest_spec_name update * @availability stack stability=stable * @availability serverless stability=stable visibility=public + * @doc_tag document */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/_global/update_by_query/UpdateByQueryRequest.ts b/specification/_global/update_by_query/UpdateByQueryRequest.ts index fca4277da3..e66b0b2206 100644 --- a/specification/_global/update_by_query/UpdateByQueryRequest.ts +++ b/specification/_global/update_by_query/UpdateByQueryRequest.ts @@ -41,6 +41,7 @@ import { Duration } from '@_types/Time' * @rest_spec_name update_by_query * @availability stack since=2.4.0 stability=stable * @availability serverless stability=stable visibility=public + * @doc_tag document */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/async_search/delete/AsyncSearchDeleteRequest.ts b/specification/async_search/delete/AsyncSearchDeleteRequest.ts index 84d8299b77..c59d0fda2e 100644 --- a/specification/async_search/delete/AsyncSearchDeleteRequest.ts +++ b/specification/async_search/delete/AsyncSearchDeleteRequest.ts @@ -29,6 +29,7 @@ import { Id } from '@_types/common' * @availability stack since=7.7.0 stability=stable * @availability serverless stability=stable visibility=public * @doc_id async-search + * @doc_tag search */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/async_search/get/AsyncSearchGetRequest.ts b/specification/async_search/get/AsyncSearchGetRequest.ts index 6ac4d2e349..023882ebef 100644 --- a/specification/async_search/get/AsyncSearchGetRequest.ts +++ b/specification/async_search/get/AsyncSearchGetRequest.ts @@ -28,6 +28,7 @@ import { Duration } from '@_types/Time' * @availability stack since=7.7.0 stability=stable * @availability serverless stability=stable visibility=public * @doc_id async-search + * @doc_tag search */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/async_search/status/AsyncSearchStatusRequest.ts b/specification/async_search/status/AsyncSearchStatusRequest.ts index cf416214d6..786d9fc736 100644 --- a/specification/async_search/status/AsyncSearchStatusRequest.ts +++ b/specification/async_search/status/AsyncSearchStatusRequest.ts @@ -28,6 +28,7 @@ import { Id } from '@_types/common' * @availability stack since=7.11.0 stability=stable * @availability serverless stability=stable visibility=public * @doc_id async-search + * @doc_tag search */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/async_search/submit/AsyncSearchSubmitRequest.ts b/specification/async_search/submit/AsyncSearchSubmitRequest.ts index c2a059fa4f..95d794c46e 100644 --- a/specification/async_search/submit/AsyncSearchSubmitRequest.ts +++ b/specification/async_search/submit/AsyncSearchSubmitRequest.ts @@ -62,6 +62,7 @@ import { Duration } from '@_types/Time' * @availability stack since=7.7.0 stability=stable * @availability serverless stability=stable visibility=public * @doc_id async-search + * @doc_tag search */ // NOTE: this is a SearchRequest with 3 added parameters: wait_for_completion_timeout, keep_on_completion and keep_alive export interface Request extends RequestBase { diff --git a/specification/cluster/delete_component_template/ClusterDeleteComponentTemplateRequest.ts b/specification/cluster/delete_component_template/ClusterDeleteComponentTemplateRequest.ts index f0bfd02836..7828bd2f37 100644 --- a/specification/cluster/delete_component_template/ClusterDeleteComponentTemplateRequest.ts +++ b/specification/cluster/delete_component_template/ClusterDeleteComponentTemplateRequest.ts @@ -30,6 +30,7 @@ import { Duration } from '@_types/Time' * @availability serverless stability=stable visibility=public * @doc_id indices-component-template * @cluster_privileges manage_index_templates + * @doc_tag indices */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/cluster/exists_component_template/ClusterComponentTemplateExistsRequest.ts b/specification/cluster/exists_component_template/ClusterComponentTemplateExistsRequest.ts index 426586fe82..0446d8f511 100644 --- a/specification/cluster/exists_component_template/ClusterComponentTemplateExistsRequest.ts +++ b/specification/cluster/exists_component_template/ClusterComponentTemplateExistsRequest.ts @@ -28,6 +28,7 @@ import { Duration } from '@_types/Time' * @availability stack since=7.8.0 stability=stable * @availability serverless stability=stable visibility=public * @doc_id indices-component-template + * @doc_tag indices */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/cluster/get_component_template/ClusterGetComponentTemplateRequest.ts b/specification/cluster/get_component_template/ClusterGetComponentTemplateRequest.ts index 1318dc53fe..d70614bae0 100644 --- a/specification/cluster/get_component_template/ClusterGetComponentTemplateRequest.ts +++ b/specification/cluster/get_component_template/ClusterGetComponentTemplateRequest.ts @@ -29,6 +29,7 @@ import { Duration } from '@_types/Time' * @availability serverless stability=stable visibility=public * @cluster_privileges manage_index_templates * @doc_id indices-component-template + * @doc_tag indices */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/cluster/health/ClusterHealthRequest.ts b/specification/cluster/health/ClusterHealthRequest.ts index 9f39081ff4..31fc593a07 100644 --- a/specification/cluster/health/ClusterHealthRequest.ts +++ b/specification/cluster/health/ClusterHealthRequest.ts @@ -37,6 +37,7 @@ import { Duration } from '@_types/Time' * @availability serverless stability=stable visibility=private * @cluster_privileges monitor, manage * @doc_id cluster-health + * @doc_tag cluster */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/cluster/put_component_template/ClusterPutComponentTemplateRequest.ts b/specification/cluster/put_component_template/ClusterPutComponentTemplateRequest.ts index 2b94fa3eb2..0f45d9ee64 100644 --- a/specification/cluster/put_component_template/ClusterPutComponentTemplateRequest.ts +++ b/specification/cluster/put_component_template/ClusterPutComponentTemplateRequest.ts @@ -44,6 +44,7 @@ import { Duration } from '@_types/Time' * @availability serverless stability=stable visibility=public * @cluster_privileges manage_index_templates * @doc_id indices-component-template + * @doc_tag indices */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/indices/data_streams_stats/IndicesDataStreamsStatsRequest.ts b/specification/indices/data_streams_stats/IndicesDataStreamsStatsRequest.ts index 37ab70805b..a3c6ddc16e 100644 --- a/specification/indices/data_streams_stats/IndicesDataStreamsStatsRequest.ts +++ b/specification/indices/data_streams_stats/IndicesDataStreamsStatsRequest.ts @@ -27,6 +27,7 @@ import { ExpandWildcards, IndexName } from '@_types/common' * @availability stack since=7.9.0 stability=stable * @availability serverless stability=stable visibility=private * @index_privileges monitor + * @doc_tag data stream */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/indices/get_data_lifecycle/IndicesGetDataLifecycleRequest.ts b/specification/indices/get_data_lifecycle/IndicesGetDataLifecycleRequest.ts index 3ffef02fdf..7ae864357c 100644 --- a/specification/indices/get_data_lifecycle/IndicesGetDataLifecycleRequest.ts +++ b/specification/indices/get_data_lifecycle/IndicesGetDataLifecycleRequest.ts @@ -27,6 +27,7 @@ import { Duration } from '@_types/Time' * @rest_spec_name indices.get_data_lifecycle * @availability stack since=8.11.0 stability=stable * @availability serverless stability=stable visibility=public + * @doc_tag data stream */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/indices/get_data_stream/IndicesGetDataStreamRequest.ts b/specification/indices/get_data_stream/IndicesGetDataStreamRequest.ts index 1818f3d71e..53a3741b7d 100644 --- a/specification/indices/get_data_stream/IndicesGetDataStreamRequest.ts +++ b/specification/indices/get_data_stream/IndicesGetDataStreamRequest.ts @@ -28,6 +28,7 @@ import { Duration } from '@_types/Time' * @availability stack since=7.9.0 stability=stable * @availability serverless stability=stable visibility=public * @index_privileges view_index_metadata + * @doc_tag data stream */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/indices/migrate_to_data_stream/IndicesMigrateToDataStreamRequest.ts b/specification/indices/migrate_to_data_stream/IndicesMigrateToDataStreamRequest.ts index b4e5b18105..10cdb3ffff 100644 --- a/specification/indices/migrate_to_data_stream/IndicesMigrateToDataStreamRequest.ts +++ b/specification/indices/migrate_to_data_stream/IndicesMigrateToDataStreamRequest.ts @@ -37,6 +37,7 @@ import { Duration } from '@_types/Time' * @availability stack since=7.9.0 stability=stable * @availability serverless stability=stable visibility=public * @index_privileges manage + * @doc_tag data stream */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/indices/modify_data_stream/IndicesModifyDataStreamRequest.ts b/specification/indices/modify_data_stream/IndicesModifyDataStreamRequest.ts index 7ac5c20d30..8e83938418 100644 --- a/specification/indices/modify_data_stream/IndicesModifyDataStreamRequest.ts +++ b/specification/indices/modify_data_stream/IndicesModifyDataStreamRequest.ts @@ -26,6 +26,7 @@ import { Action } from './types' * @rest_spec_name indices.modify_data_stream * @availability stack since=7.16.0 stability=stable * @availability serverless stability=stable visibility=public + * @doc_tag data stream */ export interface Request extends RequestBase { body: { diff --git a/specification/nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveRequest.ts b/specification/nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveRequest.ts index 2fd9a97560..6a0db3bc1f 100644 --- a/specification/nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveRequest.ts +++ b/specification/nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveRequest.ts @@ -27,6 +27,7 @@ import { long } from '@_types/Numeric' * @availability stack since=7.16.0 stability=experimental * @availability serverless stability=experimental visibility=private * @cluster_privileges monitor, manage + * @doc_tag cluster */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoRequest.ts b/specification/nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoRequest.ts index 0590503ce1..698427d263 100644 --- a/specification/nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoRequest.ts +++ b/specification/nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoRequest.ts @@ -29,6 +29,7 @@ import { NodeIds } from '@_types/common' * @availability stack since=7.16.0 stability=experimental * @availability serverless stability=experimental visibility=private * @cluster_privileges monitor, manage + * @doc_tag cluster */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/nodes/hot_threads/NodesHotThreadsRequest.ts b/specification/nodes/hot_threads/NodesHotThreadsRequest.ts index abcd41d7d5..2f3073c5cf 100644 --- a/specification/nodes/hot_threads/NodesHotThreadsRequest.ts +++ b/specification/nodes/hot_threads/NodesHotThreadsRequest.ts @@ -30,6 +30,7 @@ import { Duration } from '@_types/Time' * @availability serverless stability=stable visibility=private * @cluster_privileges monitor,manage * @doc_id cluster-nodes-hot-threads + * @doc_tag cluster */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/nodes/info/NodesInfoRequest.ts b/specification/nodes/info/NodesInfoRequest.ts index bb1f8301d3..724fa0c79d 100644 --- a/specification/nodes/info/NodesInfoRequest.ts +++ b/specification/nodes/info/NodesInfoRequest.ts @@ -27,6 +27,7 @@ import { Duration } from '@_types/Time' * @availability stack since=1.3.0 stability=stable * @availability serverless stability=stable visibility=private * @doc_id cluster-nodes-info + * @doc_tag cluster */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/nodes/reload_secure_settings/ReloadSecureSettingsRequest.ts b/specification/nodes/reload_secure_settings/ReloadSecureSettingsRequest.ts index 4bb5b2864b..783743df7c 100644 --- a/specification/nodes/reload_secure_settings/ReloadSecureSettingsRequest.ts +++ b/specification/nodes/reload_secure_settings/ReloadSecureSettingsRequest.ts @@ -25,6 +25,7 @@ import { Duration } from '@_types/Time' * Reloads the keystore on nodes in the cluster. * @rest_spec_name nodes.reload_secure_settings * @availability stack since=6.5.0 stability=stable + * @doc_tag cluster */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/nodes/stats/NodesStatsRequest.ts b/specification/nodes/stats/NodesStatsRequest.ts index 13b27f3031..b363ea64ec 100644 --- a/specification/nodes/stats/NodesStatsRequest.ts +++ b/specification/nodes/stats/NodesStatsRequest.ts @@ -28,6 +28,7 @@ import { Duration } from '@_types/Time' * @availability serverless stability=stable visibility=private * @doc_id cluster-nodes-stats * @cluster_privileges monitor,manage + * @doc_tag cluster */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/nodes/usage/NodesUsageRequest.ts b/specification/nodes/usage/NodesUsageRequest.ts index e9dfdf1a87..7508891e45 100644 --- a/specification/nodes/usage/NodesUsageRequest.ts +++ b/specification/nodes/usage/NodesUsageRequest.ts @@ -28,6 +28,7 @@ import { Duration } from '@_types/Time' * @availability serverless stability=stable visibility=private * @doc_id cluster-nodes-usage * @cluster_privileges monitor,manage + * @doc_tag cluster */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/search_application/delete_behavioral_analytics/BehavioralAnalyticsDeleteRequest.ts b/specification/search_application/delete_behavioral_analytics/BehavioralAnalyticsDeleteRequest.ts index c6e9d8a612..ae871c848c 100644 --- a/specification/search_application/delete_behavioral_analytics/BehavioralAnalyticsDeleteRequest.ts +++ b/specification/search_application/delete_behavioral_analytics/BehavioralAnalyticsDeleteRequest.ts @@ -25,6 +25,7 @@ import { Name } from '@_types/common' * @rest_spec_name search_application.delete_behavioral_analytics * @availability stack since=8.8.0 stability=experimental * @availability serverless stability=experimental visibility=public + * @doc_tag analytics */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/search_application/get_behavioral_analytics/BehavioralAnalyticsGetRequest.ts b/specification/search_application/get_behavioral_analytics/BehavioralAnalyticsGetRequest.ts index f170772a34..c59e52858f 100644 --- a/specification/search_application/get_behavioral_analytics/BehavioralAnalyticsGetRequest.ts +++ b/specification/search_application/get_behavioral_analytics/BehavioralAnalyticsGetRequest.ts @@ -24,6 +24,7 @@ import { Name } from '@_types/common' * @rest_spec_name search_application.get_behavioral_analytics * @availability stack since=8.8.0 stability=experimental * @availability serverless stability=experimental visibility=public + * @doc_tag analytics */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/search_application/put_behavioral_analytics/BehavioralAnalyticsPutRequest.ts b/specification/search_application/put_behavioral_analytics/BehavioralAnalyticsPutRequest.ts index b0b813c666..32c77aab68 100644 --- a/specification/search_application/put_behavioral_analytics/BehavioralAnalyticsPutRequest.ts +++ b/specification/search_application/put_behavioral_analytics/BehavioralAnalyticsPutRequest.ts @@ -24,6 +24,7 @@ import { Name } from '@_types/common' * @rest_spec_name search_application.put_behavioral_analytics * @availability stack since=8.8.0 stability=experimental * @availability serverless stability=experimental visibility=public + * @doc_tag analytics */ export interface Request extends RequestBase { path_parts: {