diff --git a/docs/overlays/elasticsearch-openapi-overlays.yaml b/docs/overlays/elasticsearch-openapi-overlays.yaml index dae5ff67ce..cd0724ddf8 100644 --- a/docs/overlays/elasticsearch-openapi-overlays.yaml +++ b/docs/overlays/elasticsearch-openapi-overlays.yaml @@ -53,7 +53,7 @@ actions: type: http description: | Elasticsearch APIs support the use of bearer tokens in the `Authorization` HTTP header to authenticate with the API. - For examples, refer to [Token-based authentication services](https://www.elastic.co/guide/en/elasticsearch/reference/current/token-authentication-services.html) + For examples, refer to [Token-based authentication services](https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/token-based-authentication-services) - target: '$' description: Add document security update: diff --git a/docs/overlays/elasticsearch-serverless-openapi-overlays.yaml b/docs/overlays/elasticsearch-serverless-openapi-overlays.yaml index 4faf8c65c9..908a526697 100644 --- a/docs/overlays/elasticsearch-serverless-openapi-overlays.yaml +++ b/docs/overlays/elasticsearch-serverless-openapi-overlays.yaml @@ -36,7 +36,7 @@ actions: -H "Authorization: ApiKey ${API_KEY}" ``` - To get API keys for the Elasticsearch endpoint (${ES_URL}) for a project, refer to [Connect to your Elasticsearch Serverless endpoint](https://www.elastic.co/guide/en/serverless/current/elasticsearch-connecting-to-es-serverless-endpoint.html). + For more information about where to find API keys for the Elasticsearch endpoint (${ES_URL}) for a project, go to [Get started with Elasticsearch Serverless](https://www.elastic.co/docs/solutions/search/serverless-elasticsearch-get-started). in: header name: Authorization type: apiKey diff --git a/docs/overlays/elasticsearch-shared-overlays.yaml b/docs/overlays/elasticsearch-shared-overlays.yaml index 2a8d2980ea..5d799e2f23 100644 --- a/docs/overlays/elasticsearch-shared-overlays.yaml +++ b/docs/overlays/elasticsearch-shared-overlays.yaml @@ -39,8 +39,8 @@ actions: This API requires the `manage_connector` privilege or, for read-only endpoints, the `monitor_connector` privilege. externalDocs: - url: https://www.elastic.co/guide/en/elasticsearch/reference/current/es-connectors-tutorial-api.html - description: Check out the connector API tutorial + url: https://www.elastic.co/docs/reference/search-connectors/api-tutorial + description: Check out the connector API tutorial. - name: ccr x-displayName: Cross-cluster replication # D @@ -48,12 +48,12 @@ actions: x-displayName: Data stream externalDocs: description: Learn more about data streams. - url: https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html + url: https://www.elastic.co/docs/manage-data/data-store/data-streams - name: document x-displayName: Document externalDocs: description: Learn more about reading and writing documents. - url: https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-replication.html + url: https://www.elastic.co/docs/deploy-manage/distributed-architecture/reading-and-writing-documents # E - name: enrich x-displayName: Enrich @@ -62,14 +62,14 @@ actions: 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 + url: https://www.elastic.co/docs/explore-analyze/query-filter/languages/eql description: Learn more about 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 + url: https://www.elastic.co/docs/explore-analyze/query-filter/languages/esql description: Learn more about ES|QL. # F - name: features @@ -83,7 +83,7 @@ actions: 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 + url: https://www.elastic.co/docs/explore-analyze/visualize/graph description: Get started with Graph. # I - name: indices @@ -93,7 +93,7 @@ actions: - name: ilm x-displayName: Index lifecycle management externalDocs: - url: https://www.elastic.co/guide/en/elasticsearch/reference/current/index-lifecycle-management.html + url: https://www.elastic.co/docs/manage-data/lifecycle/index-lifecycle-management description: Learn more about managing the index lifecycle. - name: inference x-displayName: Inference @@ -118,7 +118,7 @@ actions: 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 + url: https://www.elastic.co/docs/reference/logstash/logstash-centralized-pipeline-management description: Learn more about centralized pipeline management. # M - name: ml @@ -127,19 +127,19 @@ actions: x-displayName: Machine learning anomaly detection # description: externalDocs: - url: https://www.elastic.co/guide/en/machine-learning/current/ml-ad-finding-anomalies.html + url: https://www.elastic.co/docs/explore-analyze/machine-learning/anomaly-detection/ml-ad-finding-anomalies description: Learn more about finding anomalies. - name: ml data frame x-displayName: Machine learning data frame analytics # description: externalDocs: - url: https://www.elastic.co/guide/en/machine-learning/current/ml-dfa-overview.html + url: https://www.elastic.co/docs/explore-analyze/machine-learning/data-frame-analytics/ml-dfa-overview description: Learn more about data frame analytics. - name: ml trained model x-displayName: Machine learning trained model # description: externalDocs: - url: https://www.elastic.co/guide/en/machine-learning/current/ml-nlp-overview.html + url: https://www.elastic.co/docs/explore-analyze/machine-learning/nlp/ml-nlp-overview description: Learn more about natural language processing. - name: migration x-displayName: Migration @@ -159,7 +159,7 @@ actions: 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 + url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-rule-query description: Learn more about the rule query. # R - name: rollup @@ -171,7 +171,7 @@ actions: Use the script support APIs to get a list of supported script contexts and languages. Use the stored script APIs to manage stored scripts and search templates. externalDocs: - url: https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html + url: https://www.elastic.co/docs/explore-analyze/scripting - name: search x-displayName: Search - name: search_application @@ -185,21 +185,21 @@ actions: 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 + url: https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore description: Learn more about snapshot and restore operations. - 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 + url: https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/create-snapshots description: Learn more about creating 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 + url: https://www.elastic.co/docs/explore-analyze/query-filter/languages/sql description: Check out the overview and tutorials for the Elasticsearch SQL features. - name: synonyms x-displayName: Synonyms @@ -223,7 +223,7 @@ actions: description: > You can use Watcher to watch for changes or anomalies in your data and perform the necessary actions in response. externalDocs: - url: https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-alerting.html + url: https://www.elastic.co/docs/explore-analyze/alerts-cases/watcher description: Learn more about Watcher. # Add x-model and/or abbreviate schemas that should point to other references - target: "$.components['schemas']['_types.query_dsl.QueryContainer']" @@ -257,7 +257,7 @@ actions: x-model: true externalDocs: description: Templating a role query - url: https://www.elastic.co/guide/en/elasticsearch/reference/current/field-and-document-access-control.html#templating-role-query + url: https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level#templating-role-query - target: "$.components['schemas']['_types.query_dsl.DistanceFeatureQuery']" description: Add x-model for distance feature query update: @@ -1006,7 +1006,7 @@ actions: All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. By default, this property has the following value: `{"match_all": {"boost": 1}}`. externalDocs: - url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html + url: https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl description: Query DSL - target: "$.components['schemas']['ml._types.CategorizationAnalyzerDefinition'].properties.tokenizer" description: Remove tokenizer object from ML anomaly detection analysis config @@ -1027,7 +1027,7 @@ actions: Additionally, the `ml_classic` tokenizer is available, which tokenizes in the same way as the non-customizable tokenizer in old versions of the product (before 6.2). `ml_classic` was the default categorization tokenizer in versions 6.2 to 7.13, so if you need categorization identical to the default for jobs created in these versions, specify `"tokenizer": "ml_classic"` in your `categorization_analyzer`. externalDocs: - url: https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenizers.html + url: https://www.elastic.co/docs/reference/text-analysis/tokenizer-reference description: Tokenizer reference - target: "$.components['schemas']['ml._types.DataframeAnalyticsSource'].properties.query" description: Remove query object from data frame analytics source @@ -1044,7 +1044,7 @@ actions: All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. By default, this property has the following value: `{"match_all": {}}`. externalDocs: - url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html + url: https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl description: Query DSL - target: "$.components['schemas']['transform._types.Source'].properties.query" description: Remove query object from transform source @@ -1058,14 +1058,14 @@ actions: description: > A query clause that retrieves a subset of data from the source index. externalDocs: - url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html + url: https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl description: Query DSL - target: "$.components['schemas']['_global.search._types.FieldCollapse']" description: Add x-model and externalDocs update: x-model: true externalDocs: - url: https://www.elastic.co/guide/en/elasticsearch/reference/current/collapse-search-results.html + url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/collapse-search-results # - target: "$.components['schemas']['_global.msearch.MultisearchBody'].properties" # description: Add x-model # update: diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 942b00ebca..da627de1a0 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -489,7 +489,7 @@ "summary": "Get an autoscaling policy", "description": "NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/cloud/current/ec-autoscaling.html" + "url": "https://www.elastic.co/docs/deploy-manage/autoscaling" }, "operationId": "autoscaling-get-autoscaling-policy", "parameters": [ @@ -543,7 +543,7 @@ "summary": "Create or update an autoscaling policy", "description": "NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/cloud/current/ec-autoscaling.html" + "url": "https://www.elastic.co/docs/deploy-manage/autoscaling" }, "operationId": "autoscaling-put-autoscaling-policy", "parameters": [ @@ -627,7 +627,7 @@ "summary": "Delete an autoscaling policy", "description": "NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/cloud/current/ec-autoscaling.html" + "url": "https://www.elastic.co/docs/deploy-manage/autoscaling" }, "operationId": "autoscaling-delete-autoscaling-policy", "parameters": [ @@ -693,7 +693,7 @@ "summary": "Get the autoscaling capacity", "description": "NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.\n\nThis API gets the current autoscaling capacity based on the configured autoscaling policy.\nIt will return information to size the cluster appropriately to the current workload.\n\nThe `required_capacity` is calculated as the maximum of the `required_capacity` result of all individual deciders that are enabled for the policy.\n\nThe operator should verify that the `current_nodes` match the operator’s knowledge of the cluster to avoid making autoscaling decisions based on stale or incomplete information.\n\nThe response contains decider-specific information you can use to diagnose how and why autoscaling determined a certain capacity was required.\nThis information is provided for diagnosis only.\nDo not use this information to make autoscaling decisions.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/cloud/current/ec-autoscaling.html" + "url": "https://www.elastic.co/docs/deploy-manage/autoscaling" }, "operationId": "autoscaling-get-autoscaling-capacity", "parameters": [ @@ -2869,7 +2869,7 @@ "summary": "Get auto-follow patterns", "description": "Get cross-cluster replication auto-follow patterns.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-auto-follow.html" + "url": "https://www.elastic.co/docs/deploy-manage/tools/cross-cluster-replication/manage-auto-follow-patterns" }, "operationId": "ccr-get-auto-follow-pattern-1", "parameters": [ @@ -2894,7 +2894,7 @@ "summary": "Create or update auto-follow patterns", "description": "Create a collection of cross-cluster replication auto-follow patterns for a remote cluster.\nNewly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices.\nIndices on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern.\n\nThis API can also be used to update auto-follow patterns.\nNOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-auto-follow.html" + "url": "https://www.elastic.co/docs/deploy-manage/tools/cross-cluster-replication/manage-auto-follow-patterns" }, "operationId": "ccr-put-auto-follow-pattern", "parameters": [ @@ -3023,7 +3023,7 @@ "summary": "Delete auto-follow patterns", "description": "Delete a collection of cross-cluster replication auto-follow patterns.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-auto-follow.html" + "url": "https://www.elastic.co/docs/deploy-manage/tools/cross-cluster-replication/manage-auto-follow-patterns" }, "operationId": "ccr-delete-auto-follow-pattern", "parameters": [ @@ -3227,7 +3227,7 @@ "summary": "Get follower information", "description": "Get information about all cross-cluster replication follower indices.\nFor example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-ccr.html" + "url": "https://www.elastic.co/docs/deploy-manage/tools/cross-cluster-replication" }, "operationId": "ccr-follow-info", "parameters": [ @@ -3299,7 +3299,7 @@ "summary": "Get follower stats", "description": "Get cross-cluster replication follower stats.\nThe API returns shard-level stats about the \"following tasks\" associated with each shard for the specified indices.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-ccr.html" + "url": "https://www.elastic.co/docs/deploy-manage/tools/cross-cluster-replication" }, "operationId": "ccr-follow-stats", "parameters": [ @@ -3366,7 +3366,7 @@ "summary": "Forget a follower", "description": "Remove the cross-cluster replication follower retention leases from the leader.\n\nA following index takes out retention leases on its leader index.\nThese leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication.\nWhen a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed.\nHowever, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable.\nWhile the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index.\nThis API exists to enable manually removing the leases when the unfollow API is unable to do so.\n\nNOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader.\nThe only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-ccr.html" + "url": "https://www.elastic.co/docs/deploy-manage/tools/cross-cluster-replication" }, "operationId": "ccr-forget-follower", "parameters": [ @@ -3459,7 +3459,7 @@ "summary": "Get auto-follow patterns", "description": "Get cross-cluster replication auto-follow patterns.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-auto-follow.html" + "url": "https://www.elastic.co/docs/deploy-manage/tools/cross-cluster-replication/manage-auto-follow-patterns" }, "operationId": "ccr-get-auto-follow-pattern", "parameters": [ @@ -3483,7 +3483,7 @@ "summary": "Pause an auto-follow pattern", "description": "Pause a cross-cluster replication auto-follow pattern.\nWhen the API returns, the auto-follow pattern is inactive.\nNew indices that are created on the remote cluster and match the auto-follow patterns are ignored.\n\nYou can resume auto-following with the resume auto-follow pattern API.\nWhen it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns.\nRemote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-auto-follow.html" + "url": "https://www.elastic.co/docs/deploy-manage/tools/cross-cluster-replication/manage-auto-follow-patterns" }, "operationId": "ccr-pause-auto-follow-pattern", "parameters": [ @@ -3590,7 +3590,7 @@ "summary": "Resume an auto-follow pattern", "description": "Resume a cross-cluster replication auto-follow pattern that was paused.\nThe auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster.\nRemote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-auto-follow.html" + "url": "https://www.elastic.co/docs/deploy-manage/tools/cross-cluster-replication/manage-auto-follow-patterns" }, "operationId": "ccr-resume-auto-follow-pattern", "parameters": [ @@ -3645,7 +3645,7 @@ "summary": "Resume a follower", "description": "Resume a cross-cluster replication follower index that was paused.\nThe follower index could have been paused with the pause follower API.\nAlternatively it could be paused due to replication that cannot be retried due to failures during following tasks.\nWhen this API returns, the follower index will resume fetching operations from the leader index.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-ccr.html" + "url": "https://www.elastic.co/docs/deploy-manage/tools/cross-cluster-replication" }, "operationId": "ccr-resume-follow", "parameters": [ @@ -3810,7 +3810,7 @@ "summary": "Unfollow an index", "description": "Convert a cross-cluster replication follower index to a regular index.\nThe API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.\nThe follower index must be paused and closed before you call the unfollow API.\n\n> info\n> Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-ccr.html" + "url": "https://www.elastic.co/docs/deploy-manage/tools/cross-cluster-replication" }, "operationId": "ccr-unfollow", "parameters": [ @@ -3865,7 +3865,7 @@ "summary": "Run a scrolling search", "description": "IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the `search_after` parameter with a point in time (PIT).\n\nThe scroll API gets large sets of results from a single scrolling search request.\nTo get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter.\nThe `scroll` parameter indicates how long Elasticsearch should retain the search context for the request.\nThe search response returns a scroll ID in the `_scroll_id` response body parameter.\nYou can then use the scroll ID with the scroll API to retrieve the next batch of results for the request.\nIf the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.\n\nYou can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.\n\nIMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results" + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#scroll-search-results" }, "operationId": "scroll", "parameters": [ @@ -3895,7 +3895,7 @@ "summary": "Run a scrolling search", "description": "IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the `search_after` parameter with a point in time (PIT).\n\nThe scroll API gets large sets of results from a single scrolling search request.\nTo get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter.\nThe `scroll` parameter indicates how long Elasticsearch should retain the search context for the request.\nThe search response returns a scroll ID in the `_scroll_id` response body parameter.\nYou can then use the scroll ID with the scroll API to retrieve the next batch of results for the request.\nIf the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.\n\nYou can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.\n\nIMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results" + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#scroll-search-results" }, "operationId": "scroll-1", "parameters": [ @@ -3925,7 +3925,7 @@ "summary": "Clear a scrolling search", "description": "Clear the search context and results for a scrolling search.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results" + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#scroll-search-results" }, "operationId": "clear-scroll", "requestBody": { @@ -3946,7 +3946,7 @@ "summary": "Run a scrolling search", "description": "IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the `search_after` parameter with a point in time (PIT).\n\nThe scroll API gets large sets of results from a single scrolling search request.\nTo get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter.\nThe `scroll` parameter indicates how long Elasticsearch should retain the search context for the request.\nThe search response returns a scroll ID in the `_scroll_id` response body parameter.\nYou can then use the scroll ID with the scroll API to retrieve the next batch of results for the request.\nIf the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.\n\nYou can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.\n\nIMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results" + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#scroll-search-results" }, "operationId": "scroll-2", "parameters": [ @@ -3979,7 +3979,7 @@ "summary": "Run a scrolling search", "description": "IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the `search_after` parameter with a point in time (PIT).\n\nThe scroll API gets large sets of results from a single scrolling search request.\nTo get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter.\nThe `scroll` parameter indicates how long Elasticsearch should retain the search context for the request.\nThe search response returns a scroll ID in the `_scroll_id` response body parameter.\nYou can then use the scroll ID with the scroll API to retrieve the next batch of results for the request.\nIf the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.\n\nYou can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.\n\nIMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results" + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#scroll-search-results" }, "operationId": "scroll-3", "parameters": [ @@ -4012,7 +4012,7 @@ "summary": "Clear a scrolling search", "description": "Clear the search context and results for a scrolling search.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results" + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#scroll-search-results" }, "operationId": "clear-scroll-1", "parameters": [ @@ -4355,7 +4355,7 @@ "summary": "Update voting configuration exclusions", "description": "Update the cluster voting config exclusions by node IDs or node names.\nBy default, if there are more than three master-eligible nodes in the cluster and you remove fewer than half of the master-eligible nodes in the cluster at once, the voting configuration automatically shrinks.\nIf you want to shrink the voting configuration to contain fewer than three nodes or to remove half or more of the master-eligible nodes in the cluster at once, use this API to remove departing nodes from the voting configuration manually.\nThe API adds an entry for each specified node to the cluster’s voting configuration exclusions list.\nIt then waits until the cluster has reconfigured its voting configuration to exclude the specified nodes.\n\nClusters should have no voting configuration exclusions in normal operation.\nOnce the excluded nodes have stopped, clear the voting configuration exclusions with `DELETE /_cluster/voting_config_exclusions`.\nThis API waits for the nodes to be fully removed from the cluster before it returns.\nIf your cluster has voting configuration exclusions for nodes that you no longer intend to remove, use `DELETE /_cluster/voting_config_exclusions?wait_for_removal=false` to clear the voting configuration exclusions without waiting for the nodes to leave the cluster.\n\nA response to `POST /_cluster/voting_config_exclusions` with an HTTP status code of 200 OK guarantees that the node has been removed from the voting configuration and will not be reinstated until the voting configuration exclusions are cleared by calling `DELETE /_cluster/voting_config_exclusions`.\nIf the call to `POST /_cluster/voting_config_exclusions` fails or returns a response with an HTTP status code other than 200 OK then the node may not have been removed from the voting configuration.\nIn that case, you may safely retry the call.\n\nNOTE: Voting exclusions are required only when you remove at least half of the master-eligible nodes from a cluster in a short time period.\nThey are not required when removing master-ineligible nodes or when removing fewer than half of the master-eligible nodes.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/add-elasticsearch-nodes.html" + "url": "https://www.elastic.co/docs/deploy-manage/maintenance/add-and-remove-elasticsearch-nodes" }, "operationId": "cluster-post-voting-config-exclusions", "parameters": [ @@ -4417,7 +4417,7 @@ "summary": "Clear cluster voting config exclusions", "description": "Remove master-eligible nodes from the voting configuration exclusion list.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/add-elasticsearch-nodes.html" + "url": "https://www.elastic.co/docs/deploy-manage/maintenance/add-and-remove-elasticsearch-nodes" }, "operationId": "cluster-delete-voting-config-exclusions", "parameters": [ @@ -4908,7 +4908,7 @@ "summary": "Get remote cluster information", "description": "Get information about configured remote clusters.\nThe API returns connection and endpoint information keyed by the configured remote cluster alias.\n\n> info\n> This API returns information that reflects current state on the local cluster.\n> The `connected` field does not necessarily reflect whether a remote cluster is down or unavailable, only whether there is currently an open connection to it.\n> Elasticsearch does not spontaneously try to reconnect to a disconnected remote cluster.\n> To trigger a reconnection, attempt a cross-cluster search, ES|QL cross-cluster search, or try the [resolve cluster endpoint](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-cluster).", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-cross-cluster-search.html" + "url": "https://www.elastic.co/docs/solutions/search/cross-cluster-search" }, "operationId": "cluster-remote-info", "responses": { @@ -7459,7 +7459,7 @@ "summary": "Create a new document in the index", "description": "You can index a new JSON document with the `//_doc/` or `//_create/<_id>` APIs\nUsing `_create` guarantees that the document is indexed only if it does not already exist.\nIt returns a 409 response when a document with a same ID already exists in the index.\nTo update an existing document, you must use the `//_doc/` API.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:\n\n* To add a document using the `PUT //_create/<_id>` or `POST //_create/<_id>` request formats, you must have the `create_doc`, `create`, `index`, or `write` index privilege.\n* To automatically create a data stream or index with this API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege.\n\nAutomatic data stream creation requires a matching index template with data stream enabled.\n\n**Automatically create data streams and indices**\n\nIf the request's target doesn't exist and matches an index template with a `data_stream` definition, the index operation automatically creates the data stream.\n\nIf the target doesn't exist and doesn't match a data stream template, the operation automatically creates the index and applies any matching index templates.\n\nNOTE: Elasticsearch includes several built-in index templates. To avoid naming collisions with these templates, refer to index pattern documentation.\n\nIf no mapping exists, the index operation creates a dynamic mapping.\nBy default, new fields and objects are automatically added to the mapping if needed.\n\nAutomatic index creation is controlled by the `action.auto_create_index` setting.\nIf it is `true`, any index can be created automatically.\nYou can modify this setting to explicitly allow or block automatic creation of indices that match specified patterns or set it to `false` to turn off automatic index creation entirely.\nSpecify a comma-separated list of patterns you want to allow or prefix each pattern with `+` or `-` to indicate whether it should be allowed or blocked.\nWhen a list is specified, the default behaviour is to disallow.\n\nNOTE: The `action.auto_create_index` setting affects the automatic creation of indices only.\nIt does not affect the creation of data streams.\n\n**Routing**\n\nBy default, shard placement — or routing — is controlled by using a hash of the document's ID value.\nFor more explicit control, the value fed into the hash function used by the router can be directly specified on a per-operation basis using the `routing` parameter.\n\nWhen setting up explicit mapping, you can also use the `_routing` field to direct the index operation to extract the routing value from the document itself.\nThis does come at the (very minimal) cost of an additional document parsing pass.\nIf the `_routing` mapping is defined and set to be required, the index operation will fail if no routing value is provided or extracted.\n\nNOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template.\n\n**Distributed**\n\nThe index operation is directed to the primary shard based on its route and performed on the actual node containing this shard.\nAfter the primary shard completes the operation, if needed, the update is distributed to applicable replicas.\n\n**Active shards**\n\nTo improve the resiliency of writes to the system, indexing operations can be configured to wait for a certain number of active shard copies before proceeding with the operation.\nIf the requisite number of active shard copies are not available, then the write operation must wait and retry, until either the requisite shard copies have started or a timeout occurs.\nBy default, write operations only wait for the primary shards to be active before proceeding (that is to say `wait_for_active_shards` is `1`).\nThis default can be overridden in the index settings dynamically by setting `index.write.wait_for_active_shards`.\nTo alter this behavior per operation, use the `wait_for_active_shards request` parameter.\n\nValid values are all or any positive integer up to the total number of configured copies per shard in the index (which is `number_of_replicas`+1).\nSpecifying a negative value or a number greater than the number of shard copies will throw an error.\n\nFor example, suppose you have a cluster of three nodes, A, B, and C and you create an index index with the number of replicas set to 3 (resulting in 4 shard copies, one more copy than there are nodes).\nIf you attempt an indexing operation, by default the operation will only ensure the primary copy of each shard is available before proceeding.\nThis means that even if B and C went down and A hosted the primary shard copies, the indexing operation would still proceed with only one copy of the data.\nIf `wait_for_active_shards` is set on the request to `3` (and all three nodes are up), the indexing operation will require 3 active shard copies before proceeding.\nThis requirement should be met because there are 3 active nodes in the cluster, each one holding a copy of the shard.\nHowever, if you set `wait_for_active_shards` to `all` (or to `4`, which is the same in this situation), the indexing operation will not proceed as you do not have all 4 copies of each shard active in the index.\nThe operation will timeout unless a new node is brought up in the cluster to host the fourth copy of the shard.\n\nIt is important to note that this setting greatly reduces the chances of the write operation not writing to the requisite number of shard copies, but it does not completely eliminate the possibility, because this check occurs before the write operation starts.\nAfter the write operation is underway, it is still possible for replication to fail on any number of shard copies but still succeed on the primary.\nThe `_shards` section of the API response reveals the number of shard copies on which replication succeeded and failed.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html" + "url": "https://www.elastic.co/docs/manage-data/data-store/data-streams" }, "operationId": "create", "parameters": [ @@ -7526,7 +7526,7 @@ "summary": "Create a new document in the index", "description": "You can index a new JSON document with the `//_doc/` or `//_create/<_id>` APIs\nUsing `_create` guarantees that the document is indexed only if it does not already exist.\nIt returns a 409 response when a document with a same ID already exists in the index.\nTo update an existing document, you must use the `//_doc/` API.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:\n\n* To add a document using the `PUT //_create/<_id>` or `POST //_create/<_id>` request formats, you must have the `create_doc`, `create`, `index`, or `write` index privilege.\n* To automatically create a data stream or index with this API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege.\n\nAutomatic data stream creation requires a matching index template with data stream enabled.\n\n**Automatically create data streams and indices**\n\nIf the request's target doesn't exist and matches an index template with a `data_stream` definition, the index operation automatically creates the data stream.\n\nIf the target doesn't exist and doesn't match a data stream template, the operation automatically creates the index and applies any matching index templates.\n\nNOTE: Elasticsearch includes several built-in index templates. To avoid naming collisions with these templates, refer to index pattern documentation.\n\nIf no mapping exists, the index operation creates a dynamic mapping.\nBy default, new fields and objects are automatically added to the mapping if needed.\n\nAutomatic index creation is controlled by the `action.auto_create_index` setting.\nIf it is `true`, any index can be created automatically.\nYou can modify this setting to explicitly allow or block automatic creation of indices that match specified patterns or set it to `false` to turn off automatic index creation entirely.\nSpecify a comma-separated list of patterns you want to allow or prefix each pattern with `+` or `-` to indicate whether it should be allowed or blocked.\nWhen a list is specified, the default behaviour is to disallow.\n\nNOTE: The `action.auto_create_index` setting affects the automatic creation of indices only.\nIt does not affect the creation of data streams.\n\n**Routing**\n\nBy default, shard placement — or routing — is controlled by using a hash of the document's ID value.\nFor more explicit control, the value fed into the hash function used by the router can be directly specified on a per-operation basis using the `routing` parameter.\n\nWhen setting up explicit mapping, you can also use the `_routing` field to direct the index operation to extract the routing value from the document itself.\nThis does come at the (very minimal) cost of an additional document parsing pass.\nIf the `_routing` mapping is defined and set to be required, the index operation will fail if no routing value is provided or extracted.\n\nNOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template.\n\n**Distributed**\n\nThe index operation is directed to the primary shard based on its route and performed on the actual node containing this shard.\nAfter the primary shard completes the operation, if needed, the update is distributed to applicable replicas.\n\n**Active shards**\n\nTo improve the resiliency of writes to the system, indexing operations can be configured to wait for a certain number of active shard copies before proceeding with the operation.\nIf the requisite number of active shard copies are not available, then the write operation must wait and retry, until either the requisite shard copies have started or a timeout occurs.\nBy default, write operations only wait for the primary shards to be active before proceeding (that is to say `wait_for_active_shards` is `1`).\nThis default can be overridden in the index settings dynamically by setting `index.write.wait_for_active_shards`.\nTo alter this behavior per operation, use the `wait_for_active_shards request` parameter.\n\nValid values are all or any positive integer up to the total number of configured copies per shard in the index (which is `number_of_replicas`+1).\nSpecifying a negative value or a number greater than the number of shard copies will throw an error.\n\nFor example, suppose you have a cluster of three nodes, A, B, and C and you create an index index with the number of replicas set to 3 (resulting in 4 shard copies, one more copy than there are nodes).\nIf you attempt an indexing operation, by default the operation will only ensure the primary copy of each shard is available before proceeding.\nThis means that even if B and C went down and A hosted the primary shard copies, the indexing operation would still proceed with only one copy of the data.\nIf `wait_for_active_shards` is set on the request to `3` (and all three nodes are up), the indexing operation will require 3 active shard copies before proceeding.\nThis requirement should be met because there are 3 active nodes in the cluster, each one holding a copy of the shard.\nHowever, if you set `wait_for_active_shards` to `all` (or to `4`, which is the same in this situation), the indexing operation will not proceed as you do not have all 4 copies of each shard active in the index.\nThe operation will timeout unless a new node is brought up in the cluster to host the fourth copy of the shard.\n\nIt is important to note that this setting greatly reduces the chances of the write operation not writing to the requisite number of shard copies, but it does not completely eliminate the possibility, because this check occurs before the write operation starts.\nAfter the write operation is underway, it is still possible for replication to fail on any number of shard copies but still succeed on the primary.\nThe `_shards` section of the API response reveals the number of shard copies on which replication succeeded and failed.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html" + "url": "https://www.elastic.co/docs/manage-data/data-store/data-streams" }, "operationId": "create-1", "parameters": [ @@ -7943,7 +7943,7 @@ "summary": "Create or update a document in an index", "description": "Add a JSON document to the specified data stream or index and make it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.\n\nNOTE: You cannot use this API to send update requests for existing documents in a data stream.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:\n\n* To add or overwrite a document using the `PUT //_doc/<_id>` request format, you must have the `create`, `index`, or `write` index privilege.\n* To add a document using the `POST //_doc/` request format, you must have the `create_doc`, `create`, `index`, or `write` index privilege.\n* To automatically create a data stream or index with this API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege.\n\nAutomatic data stream creation requires a matching index template with data stream enabled.\n\nNOTE: Replica shards might not all be started when an indexing operation returns successfully.\nBy default, only the primary is required. Set `wait_for_active_shards` to change this default behavior.\n\n**Automatically create data streams and indices**\n\nIf the request's target doesn't exist and matches an index template with a `data_stream` definition, the index operation automatically creates the data stream.\n\nIf the target doesn't exist and doesn't match a data stream template, the operation automatically creates the index and applies any matching index templates.\n\nNOTE: Elasticsearch includes several built-in index templates. To avoid naming collisions with these templates, refer to index pattern documentation.\n\nIf no mapping exists, the index operation creates a dynamic mapping.\nBy default, new fields and objects are automatically added to the mapping if needed.\n\nAutomatic index creation is controlled by the `action.auto_create_index` setting.\nIf it is `true`, any index can be created automatically.\nYou can modify this setting to explicitly allow or block automatic creation of indices that match specified patterns or set it to `false` to turn off automatic index creation entirely.\nSpecify a comma-separated list of patterns you want to allow or prefix each pattern with `+` or `-` to indicate whether it should be allowed or blocked.\nWhen a list is specified, the default behaviour is to disallow.\n\nNOTE: The `action.auto_create_index` setting affects the automatic creation of indices only.\nIt does not affect the creation of data streams.\n\n**Optimistic concurrency control**\n\nIndex operations can be made conditional and only be performed if the last modification to the document was assigned the sequence number and primary term specified by the `if_seq_no` and `if_primary_term` parameters.\nIf a mismatch is detected, the operation will result in a `VersionConflictException` and a status code of `409`.\n\n**Routing**\n\nBy default, shard placement — or routing — is controlled by using a hash of the document's ID value.\nFor more explicit control, the value fed into the hash function used by the router can be directly specified on a per-operation basis using the `routing` parameter.\n\nWhen setting up explicit mapping, you can also use the `_routing` field to direct the index operation to extract the routing value from the document itself.\nThis does come at the (very minimal) cost of an additional document parsing pass.\nIf the `_routing` mapping is defined and set to be required, the index operation will fail if no routing value is provided or extracted.\n\nNOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template.\n\n**Distributed**\n\nThe index operation is directed to the primary shard based on its route and performed on the actual node containing this shard.\nAfter the primary shard completes the operation, if needed, the update is distributed to applicable replicas.\n\n**Active shards**\n\nTo improve the resiliency of writes to the system, indexing operations can be configured to wait for a certain number of active shard copies before proceeding with the operation.\nIf the requisite number of active shard copies are not available, then the write operation must wait and retry, until either the requisite shard copies have started or a timeout occurs.\nBy default, write operations only wait for the primary shards to be active before proceeding (that is to say `wait_for_active_shards` is `1`).\nThis default can be overridden in the index settings dynamically by setting `index.write.wait_for_active_shards`.\nTo alter this behavior per operation, use the `wait_for_active_shards request` parameter.\n\nValid values are all or any positive integer up to the total number of configured copies per shard in the index (which is `number_of_replicas`+1).\nSpecifying a negative value or a number greater than the number of shard copies will throw an error.\n\nFor example, suppose you have a cluster of three nodes, A, B, and C and you create an index index with the number of replicas set to 3 (resulting in 4 shard copies, one more copy than there are nodes).\nIf you attempt an indexing operation, by default the operation will only ensure the primary copy of each shard is available before proceeding.\nThis means that even if B and C went down and A hosted the primary shard copies, the indexing operation would still proceed with only one copy of the data.\nIf `wait_for_active_shards` is set on the request to `3` (and all three nodes are up), the indexing operation will require 3 active shard copies before proceeding.\nThis requirement should be met because there are 3 active nodes in the cluster, each one holding a copy of the shard.\nHowever, if you set `wait_for_active_shards` to `all` (or to `4`, which is the same in this situation), the indexing operation will not proceed as you do not have all 4 copies of each shard active in the index.\nThe operation will timeout unless a new node is brought up in the cluster to host the fourth copy of the shard.\n\nIt is important to note that this setting greatly reduces the chances of the write operation not writing to the requisite number of shard copies, but it does not completely eliminate the possibility, because this check occurs before the write operation starts.\nAfter the write operation is underway, it is still possible for replication to fail on any number of shard copies but still succeed on the primary.\nThe `_shards` section of the API response reveals the number of shard copies on which replication succeeded and failed.\n\n**No operation (noop) updates**\n\nWhen updating a document by using this API, a new version of the document is always created even if the document hasn't changed.\nIf this isn't acceptable use the `_update` API with `detect_noop` set to `true`.\nThe `detect_noop` option isn't available on this API because it doesn’t fetch the old source and isn't able to compare it against the new source.\n\nThere isn't a definitive rule for when noop updates aren't acceptable.\nIt's a combination of lots of factors like how frequently your data source sends updates that are actually noops and how many queries per second Elasticsearch runs on the shard receiving the updates.\n\n**Versioning**\n\nEach indexed document is given a version number.\nBy default, internal versioning is used that starts at 1 and increments with each update, deletes included.\nOptionally, the version number can be set to an external value (for example, if maintained in a database).\nTo enable this functionality, `version_type` should be set to `external`.\nThe value provided must be a numeric, long value greater than or equal to 0, and less than around `9.2e+18`.\n\nNOTE: Versioning is completely real time, and is not affected by the near real time aspects of search operations.\nIf no version is provided, the operation runs without any version checks.\n\nWhen using the external version type, the system checks to see if the version number passed to the index request is greater than the version of the currently stored document.\nIf true, the document will be indexed and the new version number used.\nIf the value provided is less than or equal to the stored document's version number, a version conflict will occur and the index operation will fail. For example:\n\n```\nPUT my-index-000001/_doc/1?version=2&version_type=external\n{\n \"user\": {\n \"id\": \"elkbee\"\n }\n}\n\nIn this example, the operation will succeed since the supplied version of 2 is higher than the current document version of 1.\nIf the document was already updated and its version was set to 2 or higher, the indexing command will fail and result in a conflict (409 HTTP status code).\n\nA nice side effect is that there is no need to maintain strict ordering of async indexing operations run as a result of changes to a source database, as long as version numbers from the source database are used.\nEven the simple case of updating the Elasticsearch index using data from a database is simplified if external versioning is used, as only the latest version will be used if the index operations arrive out of order.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html" + "url": "https://www.elastic.co/docs/manage-data/data-store/data-streams" }, "operationId": "index", "parameters": [ @@ -8006,7 +8006,7 @@ "summary": "Create or update a document in an index", "description": "Add a JSON document to the specified data stream or index and make it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.\n\nNOTE: You cannot use this API to send update requests for existing documents in a data stream.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:\n\n* To add or overwrite a document using the `PUT //_doc/<_id>` request format, you must have the `create`, `index`, or `write` index privilege.\n* To add a document using the `POST //_doc/` request format, you must have the `create_doc`, `create`, `index`, or `write` index privilege.\n* To automatically create a data stream or index with this API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege.\n\nAutomatic data stream creation requires a matching index template with data stream enabled.\n\nNOTE: Replica shards might not all be started when an indexing operation returns successfully.\nBy default, only the primary is required. Set `wait_for_active_shards` to change this default behavior.\n\n**Automatically create data streams and indices**\n\nIf the request's target doesn't exist and matches an index template with a `data_stream` definition, the index operation automatically creates the data stream.\n\nIf the target doesn't exist and doesn't match a data stream template, the operation automatically creates the index and applies any matching index templates.\n\nNOTE: Elasticsearch includes several built-in index templates. To avoid naming collisions with these templates, refer to index pattern documentation.\n\nIf no mapping exists, the index operation creates a dynamic mapping.\nBy default, new fields and objects are automatically added to the mapping if needed.\n\nAutomatic index creation is controlled by the `action.auto_create_index` setting.\nIf it is `true`, any index can be created automatically.\nYou can modify this setting to explicitly allow or block automatic creation of indices that match specified patterns or set it to `false` to turn off automatic index creation entirely.\nSpecify a comma-separated list of patterns you want to allow or prefix each pattern with `+` or `-` to indicate whether it should be allowed or blocked.\nWhen a list is specified, the default behaviour is to disallow.\n\nNOTE: The `action.auto_create_index` setting affects the automatic creation of indices only.\nIt does not affect the creation of data streams.\n\n**Optimistic concurrency control**\n\nIndex operations can be made conditional and only be performed if the last modification to the document was assigned the sequence number and primary term specified by the `if_seq_no` and `if_primary_term` parameters.\nIf a mismatch is detected, the operation will result in a `VersionConflictException` and a status code of `409`.\n\n**Routing**\n\nBy default, shard placement — or routing — is controlled by using a hash of the document's ID value.\nFor more explicit control, the value fed into the hash function used by the router can be directly specified on a per-operation basis using the `routing` parameter.\n\nWhen setting up explicit mapping, you can also use the `_routing` field to direct the index operation to extract the routing value from the document itself.\nThis does come at the (very minimal) cost of an additional document parsing pass.\nIf the `_routing` mapping is defined and set to be required, the index operation will fail if no routing value is provided or extracted.\n\nNOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template.\n\n**Distributed**\n\nThe index operation is directed to the primary shard based on its route and performed on the actual node containing this shard.\nAfter the primary shard completes the operation, if needed, the update is distributed to applicable replicas.\n\n**Active shards**\n\nTo improve the resiliency of writes to the system, indexing operations can be configured to wait for a certain number of active shard copies before proceeding with the operation.\nIf the requisite number of active shard copies are not available, then the write operation must wait and retry, until either the requisite shard copies have started or a timeout occurs.\nBy default, write operations only wait for the primary shards to be active before proceeding (that is to say `wait_for_active_shards` is `1`).\nThis default can be overridden in the index settings dynamically by setting `index.write.wait_for_active_shards`.\nTo alter this behavior per operation, use the `wait_for_active_shards request` parameter.\n\nValid values are all or any positive integer up to the total number of configured copies per shard in the index (which is `number_of_replicas`+1).\nSpecifying a negative value or a number greater than the number of shard copies will throw an error.\n\nFor example, suppose you have a cluster of three nodes, A, B, and C and you create an index index with the number of replicas set to 3 (resulting in 4 shard copies, one more copy than there are nodes).\nIf you attempt an indexing operation, by default the operation will only ensure the primary copy of each shard is available before proceeding.\nThis means that even if B and C went down and A hosted the primary shard copies, the indexing operation would still proceed with only one copy of the data.\nIf `wait_for_active_shards` is set on the request to `3` (and all three nodes are up), the indexing operation will require 3 active shard copies before proceeding.\nThis requirement should be met because there are 3 active nodes in the cluster, each one holding a copy of the shard.\nHowever, if you set `wait_for_active_shards` to `all` (or to `4`, which is the same in this situation), the indexing operation will not proceed as you do not have all 4 copies of each shard active in the index.\nThe operation will timeout unless a new node is brought up in the cluster to host the fourth copy of the shard.\n\nIt is important to note that this setting greatly reduces the chances of the write operation not writing to the requisite number of shard copies, but it does not completely eliminate the possibility, because this check occurs before the write operation starts.\nAfter the write operation is underway, it is still possible for replication to fail on any number of shard copies but still succeed on the primary.\nThe `_shards` section of the API response reveals the number of shard copies on which replication succeeded and failed.\n\n**No operation (noop) updates**\n\nWhen updating a document by using this API, a new version of the document is always created even if the document hasn't changed.\nIf this isn't acceptable use the `_update` API with `detect_noop` set to `true`.\nThe `detect_noop` option isn't available on this API because it doesn’t fetch the old source and isn't able to compare it against the new source.\n\nThere isn't a definitive rule for when noop updates aren't acceptable.\nIt's a combination of lots of factors like how frequently your data source sends updates that are actually noops and how many queries per second Elasticsearch runs on the shard receiving the updates.\n\n**Versioning**\n\nEach indexed document is given a version number.\nBy default, internal versioning is used that starts at 1 and increments with each update, deletes included.\nOptionally, the version number can be set to an external value (for example, if maintained in a database).\nTo enable this functionality, `version_type` should be set to `external`.\nThe value provided must be a numeric, long value greater than or equal to 0, and less than around `9.2e+18`.\n\nNOTE: Versioning is completely real time, and is not affected by the near real time aspects of search operations.\nIf no version is provided, the operation runs without any version checks.\n\nWhen using the external version type, the system checks to see if the version number passed to the index request is greater than the version of the currently stored document.\nIf true, the document will be indexed and the new version number used.\nIf the value provided is less than or equal to the stored document's version number, a version conflict will occur and the index operation will fail. For example:\n\n```\nPUT my-index-000001/_doc/1?version=2&version_type=external\n{\n \"user\": {\n \"id\": \"elkbee\"\n }\n}\n\nIn this example, the operation will succeed since the supplied version of 2 is higher than the current document version of 1.\nIf the document was already updated and its version was set to 2 or higher, the indexing command will fail and result in a conflict (409 HTTP status code).\n\nA nice side effect is that there is no need to maintain strict ordering of async indexing operations run as a result of changes to a source database, as long as version numbers from the source database are used.\nEven the simple case of updating the Elasticsearch index using data from a database is simplified if external versioning is used, as only the latest version will be used if the index operations arrive out of order.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html" + "url": "https://www.elastic.co/docs/manage-data/data-store/data-streams" }, "operationId": "index-1", "parameters": [ @@ -8888,7 +8888,7 @@ "summary": "Create or update a script or search template", "description": "Creates or updates a stored script or search template.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + "url": "https://www.elastic.co/docs/solutions/search/search-templates" }, "operationId": "put-script", "parameters": [ @@ -8921,7 +8921,7 @@ "summary": "Create or update a script or search template", "description": "Creates or updates a stored script or search template.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + "url": "https://www.elastic.co/docs/solutions/search/search-templates" }, "operationId": "put-script-1", "parameters": [ @@ -9449,7 +9449,7 @@ "summary": "Get EQL search results", "description": "Returns search results for an Event Query Language (EQL) query.\nEQL assumes each document in a data stream or index corresponds to an event.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql.html" + "url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/eql" }, "operationId": "eql-search", "parameters": [ @@ -9498,7 +9498,7 @@ "summary": "Get EQL search results", "description": "Returns search results for an Event Query Language (EQL) query.\nEQL assumes each document in a data stream or index corresponds to an event.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql.html" + "url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/eql" }, "operationId": "eql-search-1", "parameters": [ @@ -9549,7 +9549,7 @@ "summary": "Run an async ES|QL query", "description": "Asynchronously run an ES|QL (Elasticsearch query language) query, monitor its progress, and retrieve results when they become available.\n\nThe API accepts the same parameters and request body as the synchronous query API, along with additional async related properties.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/esql.html" + "url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/esql" }, "operationId": "esql-async-query", "parameters": [ @@ -9709,7 +9709,7 @@ "summary": "Get async ES|QL query results", "description": "Get the current status and available results or stored results for an ES|QL asynchronous query.\nIf the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can retrieve the results using this API.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/esql.html" + "url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/esql" }, "operationId": "esql-async-query-get", "parameters": [ @@ -9776,7 +9776,7 @@ "summary": "Delete an async ES|QL query", "description": "If the query is still running, it is cancelled.\nOtherwise, the stored results are deleted.\n\nIf the Elasticsearch security features are enabled, only the following users can use this API to delete a query:\n\n* The authenticated user that submitted the original query request\n* Users with the `cancel_task` cluster privilege", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/esql.html" + "url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/esql" }, "operationId": "esql-async-query-delete", "parameters": [ @@ -9815,7 +9815,7 @@ "summary": "Stop async ES|QL query", "description": "This API interrupts the query execution and returns the results so far.\nIf the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can stop it.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/esql.html" + "url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/esql" }, "operationId": "esql-async-query-stop", "parameters": [ @@ -9864,7 +9864,7 @@ "summary": "Run an ES|QL query", "description": "Get search results for an ES|QL (Elasticsearch query language) query.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/esql.html" + "url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/esql" }, "operationId": "esql-query", "parameters": [ @@ -9991,7 +9991,7 @@ "summary": "Get a document's source", "description": "Get the source of a document.\nFor example:\n\n```\nGET my-index-000001/_source/1\n```\n\nYou can use the source filtering parameters to control which parts of the `_source` are returned:\n\n```\nGET my-index-000001/_source/1/?_source_includes=*.id&_source_excludes=entities\n```", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-source-field.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-source-field" }, "operationId": "get-source", "parameters": [ @@ -10138,7 +10138,7 @@ "summary": "Check for a document source", "description": "Check whether a document source exists in an index.\nFor example:\n\n```\nHEAD my-index-000001/_source/1\n```\n\nA document's source is not available if it is disabled in the mapping.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-source-field.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-source-field" }, "operationId": "exists-source", "parameters": [ @@ -10396,7 +10396,7 @@ "summary": "Get the features", "description": "Get a list of features that can be included in snapshots using the `feature_states` field when creating a snapshot.\nYou can use this API to determine which feature states to include when taking a snapshot.\nBy default, all feature states are included in a snapshot if that snapshot includes the global state, or none if it does not.\n\nA feature state includes one or more system indices necessary for a given feature to function.\nIn order to ensure data integrity, all system indices that comprise a feature state are snapshotted and restored together.\n\nThe features listed by this API are a combination of built-in features and features defined by plugins.\nIn order for a feature state to be listed in this API and recognized as a valid feature state by the create snapshot API, the plugin that defines that feature must be installed on the master node.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-take-snapshot.html" + "url": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/create-snapshots" }, "operationId": "features-get-features", "parameters": [ @@ -11405,7 +11405,7 @@ "summary": "Explore graph analytics", "description": "Extract and summarize information about the documents and terms in an Elasticsearch data stream or index.\nThe easiest way to understand the behavior of this API is to use the Graph UI to explore connections.\nAn initial request to the `_explore` API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph.\nSubsequent requests enable you to spider out from one more vertices of interest.\nYou can exclude vertices that have already been returned.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/kibana/current/xpack-graph.html" + "url": "https://www.elastic.co/docs/explore-analyze/visualize/graph" }, "operationId": "graph-explore", "parameters": [ @@ -11435,7 +11435,7 @@ "summary": "Explore graph analytics", "description": "Extract and summarize information about the documents and terms in an Elasticsearch data stream or index.\nThe easiest way to understand the behavior of this API is to use the Graph UI to explore connections.\nAn initial request to the `_explore` API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph.\nSubsequent requests enable you to spider out from one more vertices of interest.\nYou can exclude vertices that have already been returned.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/kibana/current/xpack-graph.html" + "url": "https://www.elastic.co/docs/explore-analyze/visualize/graph" }, "operationId": "graph-explore-1", "parameters": [ @@ -11548,7 +11548,7 @@ "summary": "Create or update a lifecycle policy", "description": "If the specified policy exists, it is replaced and the policy version is incremented.\n\nNOTE: Only the latest version of the policy is stored, you cannot revert to previous versions.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-index-lifecycle.html" + "url": "https://www.elastic.co/docs/manage-data/lifecycle/index-lifecycle-management/index-lifecycle" }, "operationId": "ilm-put-lifecycle", "parameters": [ @@ -11836,7 +11836,7 @@ "summary": "Migrate to data tiers routing", "description": "Switch the indices, ILM policies, and legacy, composable, and component templates from using custom node attributes and attribute-based allocation filters to using data tiers.\nOptionally, delete one legacy index template.\nUsing node roles enables ILM to automatically move the indices between data tiers.\n\nMigrating away from custom node attributes routing can be manually performed.\nThis API provides an automated way of performing three out of the four manual steps listed in the migration guide:\n\n1. Stop setting the custom hot attribute on new indices.\n1. Remove custom allocation settings from existing ILM policies.\n1. Replace custom allocation settings from existing indices with the corresponding tier preference.\n\nILM must be stopped before performing the migration.\nUse the stop ILM and get ILM status APIs to wait until the reported operation mode is `STOPPED`.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/migrate-index-allocation-filters.html" + "url": "https://www.elastic.co/docs/manage-data/lifecycle/index-lifecycle-management/migrate-index-allocation-filters-to-node-roles" }, "operationId": "ilm-migrate-to-data-tiers", "parameters": [ @@ -12232,7 +12232,7 @@ "summary": "Create or update a document in an index", "description": "Add a JSON document to the specified data stream or index and make it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.\n\nNOTE: You cannot use this API to send update requests for existing documents in a data stream.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:\n\n* To add or overwrite a document using the `PUT //_doc/<_id>` request format, you must have the `create`, `index`, or `write` index privilege.\n* To add a document using the `POST //_doc/` request format, you must have the `create_doc`, `create`, `index`, or `write` index privilege.\n* To automatically create a data stream or index with this API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege.\n\nAutomatic data stream creation requires a matching index template with data stream enabled.\n\nNOTE: Replica shards might not all be started when an indexing operation returns successfully.\nBy default, only the primary is required. Set `wait_for_active_shards` to change this default behavior.\n\n**Automatically create data streams and indices**\n\nIf the request's target doesn't exist and matches an index template with a `data_stream` definition, the index operation automatically creates the data stream.\n\nIf the target doesn't exist and doesn't match a data stream template, the operation automatically creates the index and applies any matching index templates.\n\nNOTE: Elasticsearch includes several built-in index templates. To avoid naming collisions with these templates, refer to index pattern documentation.\n\nIf no mapping exists, the index operation creates a dynamic mapping.\nBy default, new fields and objects are automatically added to the mapping if needed.\n\nAutomatic index creation is controlled by the `action.auto_create_index` setting.\nIf it is `true`, any index can be created automatically.\nYou can modify this setting to explicitly allow or block automatic creation of indices that match specified patterns or set it to `false` to turn off automatic index creation entirely.\nSpecify a comma-separated list of patterns you want to allow or prefix each pattern with `+` or `-` to indicate whether it should be allowed or blocked.\nWhen a list is specified, the default behaviour is to disallow.\n\nNOTE: The `action.auto_create_index` setting affects the automatic creation of indices only.\nIt does not affect the creation of data streams.\n\n**Optimistic concurrency control**\n\nIndex operations can be made conditional and only be performed if the last modification to the document was assigned the sequence number and primary term specified by the `if_seq_no` and `if_primary_term` parameters.\nIf a mismatch is detected, the operation will result in a `VersionConflictException` and a status code of `409`.\n\n**Routing**\n\nBy default, shard placement — or routing — is controlled by using a hash of the document's ID value.\nFor more explicit control, the value fed into the hash function used by the router can be directly specified on a per-operation basis using the `routing` parameter.\n\nWhen setting up explicit mapping, you can also use the `_routing` field to direct the index operation to extract the routing value from the document itself.\nThis does come at the (very minimal) cost of an additional document parsing pass.\nIf the `_routing` mapping is defined and set to be required, the index operation will fail if no routing value is provided or extracted.\n\nNOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template.\n\n**Distributed**\n\nThe index operation is directed to the primary shard based on its route and performed on the actual node containing this shard.\nAfter the primary shard completes the operation, if needed, the update is distributed to applicable replicas.\n\n**Active shards**\n\nTo improve the resiliency of writes to the system, indexing operations can be configured to wait for a certain number of active shard copies before proceeding with the operation.\nIf the requisite number of active shard copies are not available, then the write operation must wait and retry, until either the requisite shard copies have started or a timeout occurs.\nBy default, write operations only wait for the primary shards to be active before proceeding (that is to say `wait_for_active_shards` is `1`).\nThis default can be overridden in the index settings dynamically by setting `index.write.wait_for_active_shards`.\nTo alter this behavior per operation, use the `wait_for_active_shards request` parameter.\n\nValid values are all or any positive integer up to the total number of configured copies per shard in the index (which is `number_of_replicas`+1).\nSpecifying a negative value or a number greater than the number of shard copies will throw an error.\n\nFor example, suppose you have a cluster of three nodes, A, B, and C and you create an index index with the number of replicas set to 3 (resulting in 4 shard copies, one more copy than there are nodes).\nIf you attempt an indexing operation, by default the operation will only ensure the primary copy of each shard is available before proceeding.\nThis means that even if B and C went down and A hosted the primary shard copies, the indexing operation would still proceed with only one copy of the data.\nIf `wait_for_active_shards` is set on the request to `3` (and all three nodes are up), the indexing operation will require 3 active shard copies before proceeding.\nThis requirement should be met because there are 3 active nodes in the cluster, each one holding a copy of the shard.\nHowever, if you set `wait_for_active_shards` to `all` (or to `4`, which is the same in this situation), the indexing operation will not proceed as you do not have all 4 copies of each shard active in the index.\nThe operation will timeout unless a new node is brought up in the cluster to host the fourth copy of the shard.\n\nIt is important to note that this setting greatly reduces the chances of the write operation not writing to the requisite number of shard copies, but it does not completely eliminate the possibility, because this check occurs before the write operation starts.\nAfter the write operation is underway, it is still possible for replication to fail on any number of shard copies but still succeed on the primary.\nThe `_shards` section of the API response reveals the number of shard copies on which replication succeeded and failed.\n\n**No operation (noop) updates**\n\nWhen updating a document by using this API, a new version of the document is always created even if the document hasn't changed.\nIf this isn't acceptable use the `_update` API with `detect_noop` set to `true`.\nThe `detect_noop` option isn't available on this API because it doesn’t fetch the old source and isn't able to compare it against the new source.\n\nThere isn't a definitive rule for when noop updates aren't acceptable.\nIt's a combination of lots of factors like how frequently your data source sends updates that are actually noops and how many queries per second Elasticsearch runs on the shard receiving the updates.\n\n**Versioning**\n\nEach indexed document is given a version number.\nBy default, internal versioning is used that starts at 1 and increments with each update, deletes included.\nOptionally, the version number can be set to an external value (for example, if maintained in a database).\nTo enable this functionality, `version_type` should be set to `external`.\nThe value provided must be a numeric, long value greater than or equal to 0, and less than around `9.2e+18`.\n\nNOTE: Versioning is completely real time, and is not affected by the near real time aspects of search operations.\nIf no version is provided, the operation runs without any version checks.\n\nWhen using the external version type, the system checks to see if the version number passed to the index request is greater than the version of the currently stored document.\nIf true, the document will be indexed and the new version number used.\nIf the value provided is less than or equal to the stored document's version number, a version conflict will occur and the index operation will fail. For example:\n\n```\nPUT my-index-000001/_doc/1?version=2&version_type=external\n{\n \"user\": {\n \"id\": \"elkbee\"\n }\n}\n\nIn this example, the operation will succeed since the supplied version of 2 is higher than the current document version of 1.\nIf the document was already updated and its version was set to 2 or higher, the indexing command will fail and result in a conflict (409 HTTP status code).\n\nA nice side effect is that there is no need to maintain strict ordering of async indexing operations run as a result of changes to a source database, as long as version numbers from the source database are used.\nEven the simple case of updating the Elasticsearch index using data from a database is simplified if external versioning is used, as only the latest version will be used if the index operations arrive out of order.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html" + "url": "https://www.elastic.co/docs/manage-data/data-store/data-streams" }, "operationId": "index-2", "parameters": [ @@ -12416,7 +12416,7 @@ "summary": "Get tokens from text analysis", "description": "The analyze API performs analysis on a text string and returns the resulting tokens.\n\nGenerating excessive amount of tokens may cause a node to run out of memory.\nThe `index.analyze.max_token_count` setting enables you to limit the number of tokens that can be produced.\nIf more than this limit of tokens gets generated, an error occurs.\nThe `_analyze` endpoint without a specified index will always use `10000` as its limit.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html" + "url": "https://www.elastic.co/docs/manage-data/data-store/text-analysis" }, "operationId": "indices-analyze", "parameters": [ @@ -12440,7 +12440,7 @@ "summary": "Get tokens from text analysis", "description": "The analyze API performs analysis on a text string and returns the resulting tokens.\n\nGenerating excessive amount of tokens may cause a node to run out of memory.\nThe `index.analyze.max_token_count` setting enables you to limit the number of tokens that can be produced.\nIf more than this limit of tokens gets generated, an error occurs.\nThe `_analyze` endpoint without a specified index will always use `10000` as its limit.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html" + "url": "https://www.elastic.co/docs/manage-data/data-store/text-analysis" }, "operationId": "indices-analyze-1", "parameters": [ @@ -12466,7 +12466,7 @@ "summary": "Get tokens from text analysis", "description": "The analyze API performs analysis on a text string and returns the resulting tokens.\n\nGenerating excessive amount of tokens may cause a node to run out of memory.\nThe `index.analyze.max_token_count` setting enables you to limit the number of tokens that can be produced.\nIf more than this limit of tokens gets generated, an error occurs.\nThe `_analyze` endpoint without a specified index will always use `10000` as its limit.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html" + "url": "https://www.elastic.co/docs/manage-data/data-store/text-analysis" }, "operationId": "indices-analyze-2", "parameters": [ @@ -12493,7 +12493,7 @@ "summary": "Get tokens from text analysis", "description": "The analyze API performs analysis on a text string and returns the resulting tokens.\n\nGenerating excessive amount of tokens may cause a node to run out of memory.\nThe `index.analyze.max_token_count` setting enables you to limit the number of tokens that can be produced.\nIf more than this limit of tokens gets generated, an error occurs.\nThe `_analyze` endpoint without a specified index will always use `10000` as its limit.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html" + "url": "https://www.elastic.co/docs/manage-data/data-store/text-analysis" }, "operationId": "indices-analyze-3", "parameters": [ @@ -14188,7 +14188,7 @@ "summary": "Get index templates", "description": "Get information about one or more index templates.\n\nIMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index-templates.html" + "url": "https://www.elastic.co/docs/manage-data/data-store/templates" }, "operationId": "indices-get-template-1", "parameters": [ @@ -14218,7 +14218,7 @@ "summary": "Create or update an index template", "description": "Index templates define settings, mappings, and aliases that can be applied automatically to new indices.\nElasticsearch applies templates to new indices based on an index pattern that matches the index name.\n\nIMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.\n\nComposable templates always take precedence over legacy templates.\nIf no composable template matches a new index, matching legacy templates are applied according to their order.\n\nIndex templates are only applied during index creation.\nChanges to index templates do not affect existing indices.\nSettings and mappings specified in create index API requests override any settings or mappings specified in an index template.\n\nYou can use C-style `/* *\\/` block comments in index templates.\nYou can include comments anywhere in the request body, except before the opening curly bracket.\n\n**Indices matching multiple templates**\n\nMultiple index templates can potentially match an index, in this case, both the settings and mappings are merged into the final configuration of the index.\nThe order of the merging can be controlled using the order parameter, with lower order being applied first, and higher orders overriding them.\nNOTE: Multiple matching templates with the same order value will result in a non-deterministic merging order.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index-templates.html" + "url": "https://www.elastic.co/docs/manage-data/data-store/templates" }, "operationId": "indices-put-template", "parameters": [ @@ -14254,7 +14254,7 @@ "summary": "Create or update an index template", "description": "Index templates define settings, mappings, and aliases that can be applied automatically to new indices.\nElasticsearch applies templates to new indices based on an index pattern that matches the index name.\n\nIMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.\n\nComposable templates always take precedence over legacy templates.\nIf no composable template matches a new index, matching legacy templates are applied according to their order.\n\nIndex templates are only applied during index creation.\nChanges to index templates do not affect existing indices.\nSettings and mappings specified in create index API requests override any settings or mappings specified in an index template.\n\nYou can use C-style `/* *\\/` block comments in index templates.\nYou can include comments anywhere in the request body, except before the opening curly bracket.\n\n**Indices matching multiple templates**\n\nMultiple index templates can potentially match an index, in this case, both the settings and mappings are merged into the final configuration of the index.\nThe order of the merging can be controlled using the order parameter, with lower order being applied first, and higher orders overriding them.\nNOTE: Multiple matching templates with the same order value will result in a non-deterministic merging order.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index-templates.html" + "url": "https://www.elastic.co/docs/manage-data/data-store/templates" }, "operationId": "indices-put-template-1", "parameters": [ @@ -14342,7 +14342,7 @@ "summary": "Check existence of index templates", "description": "Get information about whether index templates exist.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.\n\nIMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index-templates.html" + "url": "https://www.elastic.co/docs/manage-data/data-store/templates" }, "operationId": "indices-exists-template", "parameters": [ @@ -14907,7 +14907,7 @@ "summary": "Force a merge", "description": "Perform the force merge operation on the shards of one or more indices.\nFor data streams, the API forces a merge on the shards of the stream's backing indices.\n\nMerging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents.\nMerging normally happens automatically, but sometimes it is useful to trigger a merge manually.\n\nWARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes).\nWhen documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a \"tombstone\".\nThese soft-deleted documents are automatically cleaned up during regular segment merges.\nBut force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges.\nSo the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance.\nIf you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally.\n\n**Blocks during a force merge**\n\nCalls to this API block until the merge is complete (unless request contains `wait_for_completion=false`).\nIf the client connection is lost before completion then the force merge process will continue in the background.\nAny new requests to force merge the same indices will also block until the ongoing force merge is complete.\n\n**Running force merge asynchronously**\n\nIf the request contains `wait_for_completion=false`, Elasticsearch performs some preflight checks, launches the request, and returns a task you can use to get the status of the task.\nHowever, you can not cancel this task as the force merge task is not cancelable.\nElasticsearch creates a record of this task as a document at `_tasks/`.\nWhen you are done with a task, you should delete the task document so Elasticsearch can reclaim the space.\n\n**Force merging multiple indices**\n\nYou can force merge multiple indices with a single request by targeting:\n\n* One or more data streams that contain multiple backing indices\n* Multiple indices\n* One or more aliases\n* All data streams and indices in a cluster\n\nEach targeted shard is force-merged separately using the force_merge threadpool.\nBy default each node only has a single `force_merge` thread which means that the shards on that node are force-merged one at a time.\nIf you expand the `force_merge` threadpool on a node then it will force merge its shards in parallel\n\nForce merge makes the storage for the shard being merged temporarily increase, as it may require free space up to triple its size in case `max_num_segments parameter` is set to `1`, to rewrite all segments into a new one.\n\n**Data streams and time-based indices**\n\nForce-merging is useful for managing a data stream's older backing indices and other time-based indices, particularly after a rollover.\nIn these cases, each index only receives indexing traffic for a certain period of time.\nOnce an index receive no more writes, its shards can be force-merged to a single segment.\nThis can be a good idea because single-segment shards can sometimes use simpler and more efficient data structures to perform searches.\nFor example:\n\n```\nPOST /.ds-my-data-stream-2099.03.07-000001/_forcemerge?max_num_segments=1\n```", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules-merge.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/index-settings/merge" }, "operationId": "indices-forcemerge", "parameters": [ @@ -14949,7 +14949,7 @@ "summary": "Force a merge", "description": "Perform the force merge operation on the shards of one or more indices.\nFor data streams, the API forces a merge on the shards of the stream's backing indices.\n\nMerging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents.\nMerging normally happens automatically, but sometimes it is useful to trigger a merge manually.\n\nWARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes).\nWhen documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a \"tombstone\".\nThese soft-deleted documents are automatically cleaned up during regular segment merges.\nBut force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges.\nSo the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance.\nIf you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally.\n\n**Blocks during a force merge**\n\nCalls to this API block until the merge is complete (unless request contains `wait_for_completion=false`).\nIf the client connection is lost before completion then the force merge process will continue in the background.\nAny new requests to force merge the same indices will also block until the ongoing force merge is complete.\n\n**Running force merge asynchronously**\n\nIf the request contains `wait_for_completion=false`, Elasticsearch performs some preflight checks, launches the request, and returns a task you can use to get the status of the task.\nHowever, you can not cancel this task as the force merge task is not cancelable.\nElasticsearch creates a record of this task as a document at `_tasks/`.\nWhen you are done with a task, you should delete the task document so Elasticsearch can reclaim the space.\n\n**Force merging multiple indices**\n\nYou can force merge multiple indices with a single request by targeting:\n\n* One or more data streams that contain multiple backing indices\n* Multiple indices\n* One or more aliases\n* All data streams and indices in a cluster\n\nEach targeted shard is force-merged separately using the force_merge threadpool.\nBy default each node only has a single `force_merge` thread which means that the shards on that node are force-merged one at a time.\nIf you expand the `force_merge` threadpool on a node then it will force merge its shards in parallel\n\nForce merge makes the storage for the shard being merged temporarily increase, as it may require free space up to triple its size in case `max_num_segments parameter` is set to `1`, to rewrite all segments into a new one.\n\n**Data streams and time-based indices**\n\nForce-merging is useful for managing a data stream's older backing indices and other time-based indices, particularly after a rollover.\nIn these cases, each index only receives indexing traffic for a certain period of time.\nOnce an index receive no more writes, its shards can be force-merged to a single segment.\nThis can be a good idea because single-segment shards can sometimes use simpler and more efficient data structures to perform searches.\nFor example:\n\n```\nPOST /.ds-my-data-stream-2099.03.07-000001/_forcemerge?max_num_segments=1\n```", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules-merge.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/index-settings/merge" }, "operationId": "indices-forcemerge-1", "parameters": [ @@ -15299,7 +15299,7 @@ "summary": "Update field mappings", "description": "Add new fields to an existing data stream or index.\nYou can also use this API to change the search settings of existing fields and add new properties to existing object fields.\nFor data streams, these changes are applied to all backing indices by default.\n\n**Add multi-fields to an existing field**\n\nMulti-fields let you index the same field in different ways.\nYou can use this API to update the fields mapping parameter and enable multi-fields for an existing field.\nWARNING: If an index (or data stream) contains documents when you add a multi-field, those documents will not have values for the new multi-field.\nYou can populate the new multi-field with the update by query API.\n\n**Change supported mapping parameters for an existing field**\n\nThe documentation for each mapping parameter indicates whether you can update it for an existing field using this API.\nFor example, you can use the update mapping API to update the `ignore_above` parameter.\n\n**Change the mapping of an existing field**\n\nExcept for supported mapping parameters, you can't change the mapping or field type of an existing field.\nChanging an existing field could invalidate data that's already indexed.\n\nIf you need to change the mapping of a field in a data stream's backing indices, refer to documentation about modifying data streams.\nIf you need to change the mapping of a field in other indices, create a new index with the correct mapping and reindex your data into that index.\n\n**Rename a field**\n\nRenaming a field would invalidate data already indexed under the old field name.\nInstead, add an alias field to create an alternate field name.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-params.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-parameters" }, "operationId": "indices-put-mapping", "parameters": [ @@ -15341,7 +15341,7 @@ "summary": "Update field mappings", "description": "Add new fields to an existing data stream or index.\nYou can also use this API to change the search settings of existing fields and add new properties to existing object fields.\nFor data streams, these changes are applied to all backing indices by default.\n\n**Add multi-fields to an existing field**\n\nMulti-fields let you index the same field in different ways.\nYou can use this API to update the fields mapping parameter and enable multi-fields for an existing field.\nWARNING: If an index (or data stream) contains documents when you add a multi-field, those documents will not have values for the new multi-field.\nYou can populate the new multi-field with the update by query API.\n\n**Change supported mapping parameters for an existing field**\n\nThe documentation for each mapping parameter indicates whether you can update it for an existing field using this API.\nFor example, you can use the update mapping API to update the `ignore_above` parameter.\n\n**Change the mapping of an existing field**\n\nExcept for supported mapping parameters, you can't change the mapping or field type of an existing field.\nChanging an existing field could invalidate data that's already indexed.\n\nIf you need to change the mapping of a field in a data stream's backing indices, refer to documentation about modifying data streams.\nIf you need to change the mapping of a field in other indices, create a new index with the correct mapping and reindex your data into that index.\n\n**Rename a field**\n\nRenaming a field would invalidate data already indexed under the old field name.\nInstead, add an alias field to create an alternate field name.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-params.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-parameters" }, "operationId": "indices-put-mapping-1", "parameters": [ @@ -15505,7 +15505,7 @@ "summary": "Update index settings", "description": "Changes dynamic index settings in real time.\nFor data streams, index setting changes are applied to all backing indices by default.\n\nTo revert a setting to the default value, use a null value.\nThe list of per-index settings that can be updated dynamically on live indices can be found in index module documentation.\nTo preserve existing settings from being updated, set the `preserve_existing` parameter to `true`.\n\nNOTE: You can only define new analyzers on closed indices.\nTo add an analyzer, you must close the index, define the analyzer, and reopen the index.\nYou cannot close the write index of a data stream.\nTo update the analyzer for a data stream's write index and future backing indices, update the analyzer in the index template used by the stream.\nThen roll over the data stream to apply the new analyzer to the stream's write index and future backing indices.\nThis affects searches and any new data added to the stream after the rollover.\nHowever, it does not affect the data stream's backing indices or their existing data.\nTo change the analyzer for existing backing indices, you must create a new data stream and reindex your data into it.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/index-settings/index-modules" }, "operationId": "indices-put-settings", "parameters": [ @@ -15591,7 +15591,7 @@ "summary": "Update index settings", "description": "Changes dynamic index settings in real time.\nFor data streams, index setting changes are applied to all backing indices by default.\n\nTo revert a setting to the default value, use a null value.\nThe list of per-index settings that can be updated dynamically on live indices can be found in index module documentation.\nTo preserve existing settings from being updated, set the `preserve_existing` parameter to `true`.\n\nNOTE: You can only define new analyzers on closed indices.\nTo add an analyzer, you must close the index, define the analyzer, and reopen the index.\nYou cannot close the write index of a data stream.\nTo update the analyzer for a data stream's write index and future backing indices, update the analyzer in the index template used by the stream.\nThen roll over the data stream to apply the new analyzer to the stream's write index and future backing indices.\nThis affects searches and any new data added to the stream after the rollover.\nHowever, it does not affect the data stream's backing indices or their existing data.\nTo change the analyzer for existing backing indices, you must create a new data stream and reindex your data into it.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/index-settings/index-modules" }, "operationId": "indices-put-settings-1", "parameters": [ @@ -15726,7 +15726,7 @@ "summary": "Get index templates", "description": "Get information about one or more index templates.\n\nIMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index-templates.html" + "url": "https://www.elastic.co/docs/manage-data/data-store/templates" }, "operationId": "indices-get-template", "parameters": [ @@ -16203,7 +16203,7 @@ "summary": "Reload search analyzers", "description": "Reload an index's search analyzers and their resources.\nFor data streams, the API reloads search analyzers and resources for the stream's backing indices.\n\nIMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn't contain responses derived from the previous versions of the analyzer.\n\nYou can use the reload search analyzers API to pick up changes to synonym files used in the `synonym_graph` or `synonym` token filter of a search analyzer.\nTo be eligible, the token filter must have an `updateable` flag of `true` and only be used in search analyzers.\n\nNOTE: This API does not perform a reload for each shard of an index.\nInstead, it performs a reload for each node containing index shards.\nAs a result, the total shard count returned by the API can differ from the number of index shards.\nBecause reloading affects every node with an index shard, it is important to update the synonym file on every data node in the cluster--including nodes that don't contain a shard replica--before using this API.\nThis ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-analyzer.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/search-analyzer" }, "operationId": "indices-reload-search-analyzers", "parameters": [ @@ -16237,7 +16237,7 @@ "summary": "Reload search analyzers", "description": "Reload an index's search analyzers and their resources.\nFor data streams, the API reloads search analyzers and resources for the stream's backing indices.\n\nIMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn't contain responses derived from the previous versions of the analyzer.\n\nYou can use the reload search analyzers API to pick up changes to synonym files used in the `synonym_graph` or `synonym` token filter of a search analyzer.\nTo be eligible, the token filter must have an `updateable` flag of `true` and only be used in search analyzers.\n\nNOTE: This API does not perform a reload for each shard of an index.\nInstead, it performs a reload for each node containing index shards.\nAs a result, the total shard count returned by the API can differ from the number of index shards.\nBecause reloading affects every node with an index shard, it is important to update the synonym file on every data node in the cluster--including nodes that don't contain a shard replica--before using this API.\nThis ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-analyzer.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/search-analyzer" }, "operationId": "indices-reload-search-analyzers-1", "parameters": [ @@ -19857,7 +19857,7 @@ "summary": "Get pipelines", "description": "Get information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html" + "url": "https://www.elastic.co/docs/manage-data/ingest/transform-enrich/ingest-pipelines" }, "operationId": "ingest-get-pipeline-1", "parameters": [ @@ -19885,7 +19885,7 @@ "summary": "Create or update a pipeline", "description": "Changes made using this API take effect immediately.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html" + "url": "https://www.elastic.co/docs/manage-data/ingest/transform-enrich/ingest-pipelines" }, "operationId": "ingest-put-pipeline", "parameters": [ @@ -20003,7 +20003,7 @@ "summary": "Delete pipelines", "description": "Delete one or more ingest pipelines.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html" + "url": "https://www.elastic.co/docs/manage-data/ingest/transform-enrich/ingest-pipelines" }, "operationId": "ingest-delete-pipeline", "parameters": [ @@ -20062,7 +20062,7 @@ "summary": "Get GeoIP statistics", "description": "Get download statistics for GeoIP2 databases that are used with the GeoIP processor.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/geoip-processor.html" + "url": "https://www.elastic.co/docs/reference/enrich-processor/geoip-processor" }, "operationId": "ingest-geo-ip-stats", "responses": { @@ -20140,7 +20140,7 @@ "summary": "Get pipelines", "description": "Get information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html" + "url": "https://www.elastic.co/docs/manage-data/ingest/transform-enrich/ingest-pipelines" }, "operationId": "ingest-get-pipeline", "parameters": [ @@ -20167,7 +20167,7 @@ "summary": "Run a grok processor", "description": "Extract structured fields out of a single text field within a document.\nYou must choose which field to extract matched fields from, as well as the grok pattern you expect will match.\nA grok pattern is like a regular expression that supports aliased expressions that can be reused.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/grok-processor.html" + "url": "https://www.elastic.co/docs/reference/enrich-processor/grok-processor" }, "operationId": "ingest-processor-grok", "responses": { @@ -20466,7 +20466,7 @@ "summary": "Delete the license", "description": "When the license expires, your subscription level reverts to Basic.\n\nIf the operator privileges feature is enabled, only operator users can use this API.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/kibana/current/managing-licenses.html" + "url": "https://www.elastic.co/docs/deploy-manage/license/manage-your-license-in-self-managed-cluster" }, "operationId": "license-delete", "parameters": [ @@ -20758,7 +20758,7 @@ "summary": "Get Logstash pipelines", "description": "Get pipelines that are used for Logstash Central Management.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html" + "url": "https://www.elastic.co/docs/reference/logstash/logstash-centralized-pipeline-management" }, "operationId": "logstash-get-pipeline-1", "parameters": [ @@ -20780,7 +20780,7 @@ "summary": "Create or update a Logstash pipeline", "description": "Create a pipeline that is used for Logstash Central Management.\nIf the specified pipeline exists, it is replaced.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html" + "url": "https://www.elastic.co/docs/reference/logstash/logstash-centralized-pipeline-management" }, "operationId": "logstash-put-pipeline", "parameters": [ @@ -20830,7 +20830,7 @@ "summary": "Delete a Logstash pipeline", "description": "Delete a pipeline that is used for Logstash Central Management.\nIf the request succeeds, you receive an empty response with an appropriate status code.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html" + "url": "https://www.elastic.co/docs/reference/logstash/logstash-centralized-pipeline-management" }, "operationId": "logstash-delete-pipeline", "parameters": [ @@ -20865,7 +20865,7 @@ "summary": "Get Logstash pipelines", "description": "Get pipelines that are used for Logstash Central Management.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html" + "url": "https://www.elastic.co/docs/reference/logstash/logstash-centralized-pipeline-management" }, "operationId": "logstash-get-pipeline", "responses": { @@ -27807,7 +27807,7 @@ "summary": "Run multiple templated searches", "description": "Run multiple templated searches with a single request.\nIf you are providing a text file or text input to `curl`, use the `--data-binary` flag instead of `-d` to preserve newlines.\nFor example:\n\n```\n$ cat requests\n{ \"index\": \"my-index\" }\n{ \"id\": \"my-search-template\", \"params\": { \"query_string\": \"hello world\", \"from\": 0, \"size\": 10 }}\n{ \"index\": \"my-other-index\" }\n{ \"id\": \"my-other-search-template\", \"params\": { \"query_type\": \"match_all\" }}\n\n$ curl -H \"Content-Type: application/x-ndjson\" -XGET localhost:9200/_msearch/template --data-binary \"@requests\"; echo\n```", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + "url": "https://www.elastic.co/docs/solutions/search/search-templates" }, "operationId": "msearch-template", "parameters": [ @@ -27844,7 +27844,7 @@ "summary": "Run multiple templated searches", "description": "Run multiple templated searches with a single request.\nIf you are providing a text file or text input to `curl`, use the `--data-binary` flag instead of `-d` to preserve newlines.\nFor example:\n\n```\n$ cat requests\n{ \"index\": \"my-index\" }\n{ \"id\": \"my-search-template\", \"params\": { \"query_string\": \"hello world\", \"from\": 0, \"size\": 10 }}\n{ \"index\": \"my-other-index\" }\n{ \"id\": \"my-other-search-template\", \"params\": { \"query_type\": \"match_all\" }}\n\n$ curl -H \"Content-Type: application/x-ndjson\" -XGET localhost:9200/_msearch/template --data-binary \"@requests\"; echo\n```", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + "url": "https://www.elastic.co/docs/solutions/search/search-templates" }, "operationId": "msearch-template-1", "parameters": [ @@ -27883,7 +27883,7 @@ "summary": "Run multiple templated searches", "description": "Run multiple templated searches with a single request.\nIf you are providing a text file or text input to `curl`, use the `--data-binary` flag instead of `-d` to preserve newlines.\nFor example:\n\n```\n$ cat requests\n{ \"index\": \"my-index\" }\n{ \"id\": \"my-search-template\", \"params\": { \"query_string\": \"hello world\", \"from\": 0, \"size\": 10 }}\n{ \"index\": \"my-other-index\" }\n{ \"id\": \"my-other-search-template\", \"params\": { \"query_type\": \"match_all\" }}\n\n$ curl -H \"Content-Type: application/x-ndjson\" -XGET localhost:9200/_msearch/template --data-binary \"@requests\"; echo\n```", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + "url": "https://www.elastic.co/docs/solutions/search/search-templates" }, "operationId": "msearch-template-2", "parameters": [ @@ -27923,7 +27923,7 @@ "summary": "Run multiple templated searches", "description": "Run multiple templated searches with a single request.\nIf you are providing a text file or text input to `curl`, use the `--data-binary` flag instead of `-d` to preserve newlines.\nFor example:\n\n```\n$ cat requests\n{ \"index\": \"my-index\" }\n{ \"id\": \"my-search-template\", \"params\": { \"query_string\": \"hello world\", \"from\": 0, \"size\": 10 }}\n{ \"index\": \"my-other-index\" }\n{ \"id\": \"my-other-search-template\", \"params\": { \"query_type\": \"match_all\" }}\n\n$ curl -H \"Content-Type: application/x-ndjson\" -XGET localhost:9200/_msearch/template --data-binary \"@requests\"; echo\n```", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + "url": "https://www.elastic.co/docs/solutions/search/search-templates" }, "operationId": "msearch-template-3", "parameters": [ @@ -28242,7 +28242,7 @@ { "in": "path", "name": "node_id", - "description": "Comma-separated list of node IDs or names used to limit returned information.\nAll the nodes selective options are explained [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes).", + "description": "Comma-separated list of node IDs or names used to limit returned information.", "required": true, "deprecated": false, "schema": { @@ -29034,7 +29034,7 @@ "summary": "Create or update a script or search template", "description": "Creates or updates a stored script or search template.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + "url": "https://www.elastic.co/docs/solutions/search/search-templates" }, "operationId": "put-script-2", "parameters": [ @@ -29070,7 +29070,7 @@ "summary": "Create or update a script or search template", "description": "Creates or updates a stored script or search template.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + "url": "https://www.elastic.co/docs/solutions/search/search-templates" }, "operationId": "put-script-3", "parameters": [ @@ -29108,7 +29108,7 @@ "summary": "Get a query rule", "description": "Get details about a query rule within a query ruleset.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-using-query-rules.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/searching-with-query-rules" }, "operationId": "query-rules-get-rule", "parameters": [ @@ -29348,7 +29348,7 @@ "summary": "Create or update a query ruleset", "description": "There is a limit of 100 rules per ruleset.\nThis limit can be increased by using the `xpack.applications.rules.max_rules_per_ruleset` cluster setting.\n\nIMPORTANT: Due to limitations within pinned queries, you can only select documents using `ids` or `docs`, but cannot use both in single rule.\nIt is advised to use one or the other in query rulesets, to avoid errors.\nAdditionally, pinned queries have a maximum limit of 100 pinned hits.\nIf multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-using-query-rules.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/searching-with-query-rules" }, "operationId": "query-rules-put-ruleset", "parameters": [ @@ -30640,7 +30640,7 @@ "summary": "Run a search", "description": "Get search hits that match the query defined in the request.\nYou can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.\n\nIf the Elasticsearch security features are enabled, you must have the read index privilege for the target data stream, index, or alias. For cross-cluster search, refer to the documentation about configuring CCS privileges.\nTo search a point in time (PIT) for an alias, you must have the `read` index privilege for the alias's data streams or indices.\n\n**Search slicing**\n\nWhen paging through a large number of documents, it can be helpful to split the search into multiple slices to consume them independently with the `slice` and `pit` properties.\nBy default the splitting is done first on the shards, then locally on each shard.\nThe local splitting partitions the shard into contiguous ranges based on Lucene document IDs.\n\nFor instance if the number of shards is equal to 2 and you request 4 slices, the slices 0 and 2 are assigned to the first shard and the slices 1 and 3 are assigned to the second shard.\n\nIMPORTANT: The same point-in-time ID should be used for all slices.\nIf different PIT IDs are used, slices can overlap and miss documents.\nThis situation can occur because the splitting criterion is based on Lucene document IDs, which are not stable across changes to the index.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/remote-clusters-cert.html#remote-clusters-privileges-ccs" + "url": "https://www.elastic.co/docs/deploy-manage/remote-clusters/remote-clusters-cert#remote-clusters-privileges-ccs" }, "operationId": "search", "parameters": [ @@ -30793,7 +30793,7 @@ "summary": "Run a search", "description": "Get search hits that match the query defined in the request.\nYou can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.\n\nIf the Elasticsearch security features are enabled, you must have the read index privilege for the target data stream, index, or alias. For cross-cluster search, refer to the documentation about configuring CCS privileges.\nTo search a point in time (PIT) for an alias, you must have the `read` index privilege for the alias's data streams or indices.\n\n**Search slicing**\n\nWhen paging through a large number of documents, it can be helpful to split the search into multiple slices to consume them independently with the `slice` and `pit` properties.\nBy default the splitting is done first on the shards, then locally on each shard.\nThe local splitting partitions the shard into contiguous ranges based on Lucene document IDs.\n\nFor instance if the number of shards is equal to 2 and you request 4 slices, the slices 0 and 2 are assigned to the first shard and the slices 1 and 3 are assigned to the second shard.\n\nIMPORTANT: The same point-in-time ID should be used for all slices.\nIf different PIT IDs are used, slices can overlap and miss documents.\nThis situation can occur because the splitting criterion is based on Lucene document IDs, which are not stable across changes to the index.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/remote-clusters-cert.html#remote-clusters-privileges-ccs" + "url": "https://www.elastic.co/docs/deploy-manage/remote-clusters/remote-clusters-cert#remote-clusters-privileges-ccs" }, "operationId": "search-1", "parameters": [ @@ -30948,7 +30948,7 @@ "summary": "Run a search", "description": "Get search hits that match the query defined in the request.\nYou can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.\n\nIf the Elasticsearch security features are enabled, you must have the read index privilege for the target data stream, index, or alias. For cross-cluster search, refer to the documentation about configuring CCS privileges.\nTo search a point in time (PIT) for an alias, you must have the `read` index privilege for the alias's data streams or indices.\n\n**Search slicing**\n\nWhen paging through a large number of documents, it can be helpful to split the search into multiple slices to consume them independently with the `slice` and `pit` properties.\nBy default the splitting is done first on the shards, then locally on each shard.\nThe local splitting partitions the shard into contiguous ranges based on Lucene document IDs.\n\nFor instance if the number of shards is equal to 2 and you request 4 slices, the slices 0 and 2 are assigned to the first shard and the slices 1 and 3 are assigned to the second shard.\n\nIMPORTANT: The same point-in-time ID should be used for all slices.\nIf different PIT IDs are used, slices can overlap and miss documents.\nThis situation can occur because the splitting criterion is based on Lucene document IDs, which are not stable across changes to the index.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/remote-clusters-cert.html#remote-clusters-privileges-ccs" + "url": "https://www.elastic.co/docs/deploy-manage/remote-clusters/remote-clusters-cert#remote-clusters-privileges-ccs" }, "operationId": "search-2", "parameters": [ @@ -31104,7 +31104,7 @@ "summary": "Run a search", "description": "Get search hits that match the query defined in the request.\nYou can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.\n\nIf the Elasticsearch security features are enabled, you must have the read index privilege for the target data stream, index, or alias. For cross-cluster search, refer to the documentation about configuring CCS privileges.\nTo search a point in time (PIT) for an alias, you must have the `read` index privilege for the alias's data streams or indices.\n\n**Search slicing**\n\nWhen paging through a large number of documents, it can be helpful to split the search into multiple slices to consume them independently with the `slice` and `pit` properties.\nBy default the splitting is done first on the shards, then locally on each shard.\nThe local splitting partitions the shard into contiguous ranges based on Lucene document IDs.\n\nFor instance if the number of shards is equal to 2 and you request 4 slices, the slices 0 and 2 are assigned to the first shard and the slices 1 and 3 are assigned to the second shard.\n\nIMPORTANT: The same point-in-time ID should be used for all slices.\nIf different PIT IDs are used, slices can overlap and miss documents.\nThis situation can occur because the splitting criterion is based on Lucene document IDs, which are not stable across changes to the index.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/remote-clusters-cert.html#remote-clusters-privileges-ccs" + "url": "https://www.elastic.co/docs/deploy-manage/remote-clusters/remote-clusters-cert#remote-clusters-privileges-ccs" }, "operationId": "search-3", "parameters": [ @@ -31585,7 +31585,7 @@ ], "summary": "Create a behavioral analytics collection event", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/behavioral-analytics-event-reference.html" + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/behavioral-analytics-event-reference.html" }, "operationId": "search-application-post-behavioral-analytics-event", "parameters": [ @@ -32061,7 +32061,7 @@ ], "summary": "Run a search with a search template", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + "url": "https://www.elastic.co/docs/solutions/search/search-templates" }, "operationId": "search-template", "parameters": [ @@ -32121,7 +32121,7 @@ ], "summary": "Run a search with a search template", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + "url": "https://www.elastic.co/docs/solutions/search/search-templates" }, "operationId": "search-template-1", "parameters": [ @@ -32183,7 +32183,7 @@ ], "summary": "Run a search with a search template", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + "url": "https://www.elastic.co/docs/solutions/search/search-templates" }, "operationId": "search-template-2", "parameters": [ @@ -32246,7 +32246,7 @@ ], "summary": "Run a search with a search template", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + "url": "https://www.elastic.co/docs/solutions/search/search-templates" }, "operationId": "search-template-3", "parameters": [ @@ -32312,7 +32312,7 @@ "summary": "Get cache statistics", "description": "Get statistics about the shared cache for partially mounted indices.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots.html" + "url": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/searchable-snapshots" }, "operationId": "searchable-snapshots-cache-stats", "parameters": [ @@ -32336,7 +32336,7 @@ "summary": "Get cache statistics", "description": "Get statistics about the shared cache for partially mounted indices.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots.html" + "url": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/searchable-snapshots" }, "operationId": "searchable-snapshots-cache-stats-1", "parameters": [ @@ -32363,7 +32363,7 @@ "summary": "Clear the cache", "description": "Clear indices and data streams from the shared cache for partially mounted indices.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots.html" + "url": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/searchable-snapshots" }, "operationId": "searchable-snapshots-clear-cache", "parameters": [ @@ -32393,7 +32393,7 @@ "summary": "Clear the cache", "description": "Clear indices and data streams from the shared cache for partially mounted indices.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots.html" + "url": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/searchable-snapshots" }, "operationId": "searchable-snapshots-clear-cache-1", "parameters": [ @@ -33281,7 +33281,7 @@ "summary": "Clear the user cache", "description": "Evict users from the user cache.\nYou can completely clear the cache or evict specific users.\n\nUser credentials are cached in memory on each node to avoid connecting to a remote authentication service or hitting the disk for every incoming request.\nThere are realm settings that you can use to configure the user cache.\nFor more information, refer to the documentation about controlling the user cache.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/controlling-user-cache.html" + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-user-cache" }, "operationId": "security-clear-cached-realms", "parameters": [ @@ -33405,7 +33405,7 @@ "summary": "Clear service account token caches", "description": "Evict a subset of all entries from the service account token caches.\nTwo separate caches exist for service account tokens: one cache for tokens backed by the `service_tokens` file, and another for tokens backed by the `.security` index.\nThis API clears matching entries from both caches.\n\nThe cache for service account tokens backed by the `.security` index is cleared automatically on state changes of the security index.\nThe cache for tokens backed by the `service_tokens` file is cleared automatically on file changes.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/service-accounts.html" + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/service-accounts" }, "operationId": "security-clear-cached-service-tokens", "parameters": [ @@ -33610,7 +33610,7 @@ "summary": "Create an API key", "description": "Create an API key for access without requiring basic authentication.\n\nIMPORTANT: If the credential that is used to authenticate this request is an API key, the derived API key cannot have any privileges.\nIf you specify privileges, the API returns an error.\n\nA successful request returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\n\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.\n\nThe API keys are created by the Elasticsearch API key service, which is automatically enabled.\nTo configure or turn off the API key service, refer to API key service setting documentation.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-settings.html#api-key-service-settings" + "url": "https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/security-settings#api-key-service-settings" }, "operationId": "security-create-api-key", "parameters": [ @@ -33635,7 +33635,7 @@ "summary": "Create an API key", "description": "Create an API key for access without requiring basic authentication.\n\nIMPORTANT: If the credential that is used to authenticate this request is an API key, the derived API key cannot have any privileges.\nIf you specify privileges, the API returns an error.\n\nA successful request returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\n\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.\n\nThe API keys are created by the Elasticsearch API key service, which is automatically enabled.\nTo configure or turn off the API key service, refer to API key service setting documentation.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-settings.html#api-key-service-settings" + "url": "https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/security-settings#api-key-service-settings" }, "operationId": "security-create-api-key-1", "parameters": [ @@ -33789,7 +33789,7 @@ "summary": "Create a cross-cluster API key", "description": "Create an API key of the `cross_cluster` type for the API key based remote cluster access.\nA `cross_cluster` API key cannot be used to authenticate through the REST interface.\n\nIMPORTANT: To authenticate this request you must use a credential that is not an API key. Even if you use an API key that has the required privilege, the API returns an error.\n\nCross-cluster API keys are created by the Elasticsearch API key service, which is automatically enabled.\n\nNOTE: Unlike REST API keys, a cross-cluster API key does not capture permissions of the authenticated user. The API key’s effective permission is exactly as specified with the `access` property.\n\nA successful request returns a JSON structure that contains the API key, its unique ID, and its name. If applicable, it also returns expiration information for the API key in milliseconds.\n\nBy default, API keys never expire. You can specify expiration information when you create the API keys.\n\nCross-cluster API keys can only be updated with the update cross-cluster API key API.\nAttempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/remote-clusters-api-key.html" + "url": "https://www.elastic.co/docs/deploy-manage/remote-clusters/remote-clusters-api-key" }, "operationId": "security-create-cross-cluster-api-key", "requestBody": { @@ -33879,7 +33879,7 @@ "summary": "Create a service account token", "description": "Create a service accounts token for access without requiring basic authentication.\n\nNOTE: Service account tokens never expire.\nYou must actively delete them if they are no longer needed.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/service-accounts.html" + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/service-accounts" }, "operationId": "security-create-service-token", "parameters": [ @@ -33909,7 +33909,7 @@ "summary": "Create a service account token", "description": "Create a service accounts token for access without requiring basic authentication.\n\nNOTE: Service account tokens never expire.\nYou must actively delete them if they are no longer needed.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/service-accounts.html" + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/service-accounts" }, "operationId": "security-create-service-token-1", "parameters": [ @@ -33939,7 +33939,7 @@ "summary": "Delete service account tokens", "description": "Delete service account tokens for a service in a specified namespace.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/service-accounts.html" + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/service-accounts" }, "operationId": "security-delete-service-token", "parameters": [ @@ -34025,7 +34025,7 @@ "summary": "Create a service account token", "description": "Create a service accounts token for access without requiring basic authentication.\n\nNOTE: Service account tokens never expire.\nYou must actively delete them if they are no longer needed.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/service-accounts.html" + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/service-accounts" }, "operationId": "security-create-service-token-2", "parameters": [ @@ -34054,7 +34054,7 @@ "summary": "Delegate PKI authentication", "description": "This API implements the exchange of an X509Certificate chain for an Elasticsearch access token.\nThe certificate chain is validated, according to RFC 5280, by sequentially considering the trust configuration of every installed PKI realm that has `delegation.enabled` set to `true`.\nA successfully trusted client certificate is also subject to the validation of the subject distinguished name according to thw `username_pattern` of the respective realm.\n\nThis API is called by smart and trusted proxies, such as Kibana, which terminate the user's TLS session but still want to authenticate the user by using a PKI realm—-​as if the user connected directly to Elasticsearch.\n\nIMPORTANT: The association between the subject public key in the target certificate and the corresponding private key is not validated.\nThis is part of the TLS authentication process and it is delegated to the proxy that calls this API.\nThe proxy is trusted to have performed the TLS authentication and this API translates that authentication into an Elasticsearch access token.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/pki-realm.html" + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/pki" }, "operationId": "security-delegate-pki", "requestBody": { @@ -34136,7 +34136,7 @@ "summary": "Get application privileges", "description": "To use this API, you must have one of the following privileges:\n\n* The `read_security` cluster privilege (or a greater privilege such as `manage_security` or `all`).\n* The \"Manage Application Privileges\" global privilege for the application being referenced in the request.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/security-privileges" }, "operationId": "security-get-privileges-2", "parameters": [ @@ -34161,7 +34161,7 @@ "summary": "Delete application privileges", "description": "To use this API, you must have one of the following privileges:\n\n* The `manage_security` cluster privilege (or a greater privilege such as `all`).\n* The \"Manage Application Privileges\" global privilege for the application being referenced in the request.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/security-privileges" }, "operationId": "security-delete-privileges", "parameters": [ @@ -34251,7 +34251,7 @@ "summary": "Create or update roles", "description": "The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management.\nThe create or update roles API cannot update roles that are defined in roles files.\nFile-based role management is not available in Elastic Serverless.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/defining-roles.html" + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/defining-roles" }, "operationId": "security-put-role", "parameters": [ @@ -34278,7 +34278,7 @@ "summary": "Create or update roles", "description": "The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management.\nThe create or update roles API cannot update roles that are defined in roles files.\nFile-based role management is not available in Elastic Serverless.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/defining-roles.html" + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/defining-roles" }, "operationId": "security-put-role-1", "parameters": [ @@ -34365,7 +34365,7 @@ "summary": "Get role mappings", "description": "Role mappings define which roles are assigned to each user.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files.\nThe get role mappings API cannot retrieve role mappings that are defined in role mapping files.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-roles.html" + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/mapping-users-groups-to-roles" }, "operationId": "security-get-role-mapping", "parameters": [ @@ -34387,7 +34387,7 @@ "summary": "Create or update role mappings", "description": "Role mappings define which roles are assigned to each user.\nEach mapping has rules that identify users and a list of roles that are granted to those users.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files.\n\nNOTE: This API does not create roles. Rather, it maps users to existing roles.\nRoles can be created by using the create or update roles API or roles files.\n\n**Role templates**\n\nThe most common use for role mappings is to create a mapping from a known value on the user to a fixed role name.\nFor example, all users in the `cn=admin,dc=example,dc=com` LDAP group should be given the superuser role in Elasticsearch.\nThe `roles` field is used for this purpose.\n\nFor more complex needs, it is possible to use Mustache templates to dynamically determine the names of the roles that should be granted to the user.\nThe `role_templates` field is used for this purpose.\n\nNOTE: To use role templates successfully, the relevant scripting feature must be enabled.\nOtherwise, all attempts to create a role mapping with role templates fail.\n\nAll of the user fields that are available in the role mapping rules are also available in the role templates.\nThus it is possible to assign a user to a role that reflects their username, their groups, or the name of the realm to which they authenticated.\n\nBy default a template is evaluated to produce a single string that is the name of the role which should be assigned to the user.\nIf the format of the template is set to \"json\" then the template is expected to produce a JSON string or an array of JSON strings for the role names.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-roles.html" + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/mapping-users-groups-to-roles" }, "operationId": "security-put-role-mapping", "parameters": [ @@ -34415,7 +34415,7 @@ "summary": "Create or update role mappings", "description": "Role mappings define which roles are assigned to each user.\nEach mapping has rules that identify users and a list of roles that are granted to those users.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files.\n\nNOTE: This API does not create roles. Rather, it maps users to existing roles.\nRoles can be created by using the create or update roles API or roles files.\n\n**Role templates**\n\nThe most common use for role mappings is to create a mapping from a known value on the user to a fixed role name.\nFor example, all users in the `cn=admin,dc=example,dc=com` LDAP group should be given the superuser role in Elasticsearch.\nThe `roles` field is used for this purpose.\n\nFor more complex needs, it is possible to use Mustache templates to dynamically determine the names of the roles that should be granted to the user.\nThe `role_templates` field is used for this purpose.\n\nNOTE: To use role templates successfully, the relevant scripting feature must be enabled.\nOtherwise, all attempts to create a role mapping with role templates fail.\n\nAll of the user fields that are available in the role mapping rules are also available in the role templates.\nThus it is possible to assign a user to a role that reflects their username, their groups, or the name of the realm to which they authenticated.\n\nBy default a template is evaluated to produce a single string that is the name of the role which should be assigned to the user.\nIf the format of the template is set to \"json\" then the template is expected to produce a JSON string or an array of JSON strings for the role names.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-roles.html" + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/mapping-users-groups-to-roles" }, "operationId": "security-put-role-mapping-1", "parameters": [ @@ -34443,7 +34443,7 @@ "summary": "Delete role mappings", "description": "Role mappings define which roles are assigned to each user.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files.\nThe delete role mappings API cannot remove role mappings that are defined in role mapping files.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-roles.html" + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/mapping-users-groups-to-roles" }, "operationId": "security-delete-role-mapping", "parameters": [ @@ -34924,7 +34924,7 @@ "summary": "Get builtin privileges", "description": "Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/security-privileges" }, "operationId": "security-get-builtin-privileges", "responses": { @@ -34984,7 +34984,7 @@ "summary": "Get application privileges", "description": "To use this API, you must have one of the following privileges:\n\n* The `read_security` cluster privilege (or a greater privilege such as `manage_security` or `all`).\n* The \"Manage Application Privileges\" global privilege for the application being referenced in the request.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/security-privileges" }, "operationId": "security-get-privileges", "responses": { @@ -35001,7 +35001,7 @@ "summary": "Create or update application privileges", "description": "To use this API, you must have one of the following privileges:\n\n* The `manage_security` cluster privilege (or a greater privilege such as `all`).\n* The \"Manage Application Privileges\" global privilege for the application being referenced in the request.\n\nApplication names are formed from a prefix, with an optional suffix that conform to the following rules:\n\n* The prefix must begin with a lowercase ASCII letter.\n* The prefix must contain only ASCII letters or digits.\n* The prefix must be at least 3 characters long.\n* If the suffix exists, it must begin with either a dash `-` or `_`.\n* The suffix cannot contain any of the following characters: `\\`, `/`, `*`, `?`, `\"`, `<`, `>`, `|`, `,`, `*`.\n* No part of the name can contain whitespace.\n\nPrivilege names must begin with a lowercase ASCII letter and must contain only ASCII letters and digits along with the characters `_`, `-`, and `.`.\n\nAction names can contain any number of printable ASCII characters and must contain at least one of the following characters: `/`, `*`, `:`.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/security-privileges" }, "operationId": "security-put-privileges", "parameters": [ @@ -35026,7 +35026,7 @@ "summary": "Create or update application privileges", "description": "To use this API, you must have one of the following privileges:\n\n* The `manage_security` cluster privilege (or a greater privilege such as `all`).\n* The \"Manage Application Privileges\" global privilege for the application being referenced in the request.\n\nApplication names are formed from a prefix, with an optional suffix that conform to the following rules:\n\n* The prefix must begin with a lowercase ASCII letter.\n* The prefix must contain only ASCII letters or digits.\n* The prefix must be at least 3 characters long.\n* If the suffix exists, it must begin with either a dash `-` or `_`.\n* The suffix cannot contain any of the following characters: `\\`, `/`, `*`, `?`, `\"`, `<`, `>`, `|`, `,`, `*`.\n* No part of the name can contain whitespace.\n\nPrivilege names must begin with a lowercase ASCII letter and must contain only ASCII letters and digits along with the characters `_`, `-`, and `.`.\n\nAction names can contain any number of printable ASCII characters and must contain at least one of the following characters: `/`, `*`, `:`.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/security-privileges" }, "operationId": "security-put-privileges-1", "parameters": [ @@ -35053,7 +35053,7 @@ "summary": "Get application privileges", "description": "To use this API, you must have one of the following privileges:\n\n* The `read_security` cluster privilege (or a greater privilege such as `manage_security` or `all`).\n* The \"Manage Application Privileges\" global privilege for the application being referenced in the request.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/security-privileges" }, "operationId": "security-get-privileges-1", "parameters": [ @@ -35077,7 +35077,7 @@ "summary": "Get role mappings", "description": "Role mappings define which roles are assigned to each user.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files.\nThe get role mappings API cannot retrieve role mappings that are defined in role mapping files.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-roles.html" + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/mapping-users-groups-to-roles" }, "operationId": "security-get-role-mapping-1", "responses": { @@ -35096,7 +35096,7 @@ "summary": "Get service accounts", "description": "Get a list of service accounts that match the provided path parameters.\n\nNOTE: Currently, only the `elastic/fleet-server` service account is available.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/service-accounts.html" + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/service-accounts" }, "operationId": "security-get-service-accounts", "parameters": [ @@ -35123,7 +35123,7 @@ "summary": "Get service accounts", "description": "Get a list of service accounts that match the provided path parameters.\n\nNOTE: Currently, only the `elastic/fleet-server` service account is available.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/service-accounts.html" + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/service-accounts" }, "operationId": "security-get-service-accounts-1", "parameters": [ @@ -35147,7 +35147,7 @@ "summary": "Get service accounts", "description": "Get a list of service accounts that match the provided path parameters.\n\nNOTE: Currently, only the `elastic/fleet-server` service account is available.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/service-accounts.html" + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/service-accounts" }, "operationId": "security-get-service-accounts-2", "responses": { @@ -35166,7 +35166,7 @@ "summary": "Get service account credentials", "description": "To use this API, you must have at least the `read_security` cluster privilege (or a greater privilege such as `manage_service_account` or `manage_security`).\n\nThe response includes service account tokens that were created with the create service account tokens API as well as file-backed tokens from all nodes of the cluster.\n\nNOTE: For tokens backed by the `service_tokens` file, the API collects them from all nodes of the cluster.\nTokens with the same name from different nodes are assumed to be the same token and are only counted once towards the total number of service tokens.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/service-accounts.html" + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/service-accounts" }, "operationId": "security-get-service-credentials", "parameters": [ @@ -35372,7 +35372,7 @@ "summary": "Get a token", "description": "Create a bearer token for access without requiring basic authentication.\nThe tokens are created by the Elasticsearch Token Service, which is automatically enabled when you configure TLS on the HTTP interface.\nAlternatively, you can explicitly enable the `xpack.security.authc.token.enabled` setting.\nWhen you are running in production mode, a bootstrap check prevents you from enabling the token service unless you also enable TLS on the HTTP interface.\n\nThe get token API takes the same parameters as a typical OAuth 2.0 token API except for the use of a JSON request body.\n\nA successful get token API call returns a JSON structure that contains the access token, the amount of time (seconds) that the token expires in, the type, and the scope if available.\n\nThe tokens returned by the get token API have a finite period of time for which they are valid and after that time period, they can no longer be used.\nThat time period is defined by the `xpack.security.authc.token.timeout` setting.\nIf you want to invalidate a token immediately, you can do so by using the invalidate token API.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-basic-setup-https.html#encrypt-http-communication" + "url": "https://www.elastic.co/docs/deploy-manage/security/set-up-basic-security-plus-https#encrypt-http-communication" }, "operationId": "security-get-token", "requestBody": { @@ -35920,7 +35920,7 @@ "summary": "Check user privileges", "description": "Determine whether the specified user has a specified list of privileges.\nAll users can use this API, but only to determine their own privileges.\nTo check the privileges of other users, you must use the run as feature.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/security-privileges" }, "operationId": "security-has-privileges", "requestBody": { @@ -35940,7 +35940,7 @@ "summary": "Check user privileges", "description": "Determine whether the specified user has a specified list of privileges.\nAll users can use this API, but only to determine their own privileges.\nTo check the privileges of other users, you must use the run as feature.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/security-privileges" }, "operationId": "security-has-privileges-1", "requestBody": { @@ -35962,7 +35962,7 @@ "summary": "Check user privileges", "description": "Determine whether the specified user has a specified list of privileges.\nAll users can use this API, but only to determine their own privileges.\nTo check the privileges of other users, you must use the run as feature.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/security-privileges" }, "operationId": "security-has-privileges-2", "parameters": [ @@ -35987,7 +35987,7 @@ "summary": "Check user privileges", "description": "Determine whether the specified user has a specified list of privileges.\nAll users can use this API, but only to determine their own privileges.\nTo check the privileges of other users, you must use the run as feature.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/security-privileges" }, "operationId": "security-has-privileges-3", "parameters": [ @@ -36014,7 +36014,7 @@ "summary": "Check user profile privileges", "description": "Determine whether the users associated with the specified user profile IDs have all the requested privileges.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/user-profile.html" + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/user-profiles" }, "operationId": "security-has-privileges-user-profile", "requestBody": { @@ -36034,7 +36034,7 @@ "summary": "Check user profile privileges", "description": "Determine whether the users associated with the specified user profile IDs have all the requested privileges.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/user-profile.html" + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/user-profiles" }, "operationId": "security-has-privileges-user-profile-1", "requestBody": { @@ -36451,7 +36451,7 @@ "summary": "Authenticate SAML", "description": "Submit a SAML response message to Elasticsearch for consumption.\n\nNOTE: This API is intended for use by custom web applications other than Kibana.\nIf you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.\n\nThe SAML message that is submitted can be:\n\n* A response to a SAML authentication request that was previously created using the SAML prepare authentication API.\n* An unsolicited SAML message in the case of an IdP-initiated single sign-on (SSO) flow.\n\nIn either case, the SAML message needs to be a base64 encoded XML document with a root element of ``.\n\nAfter successful validation, Elasticsearch responds with an Elasticsearch internal access token and refresh token that can be subsequently used for authentication.\nThis API endpoint essentially exchanges SAML responses that indicate successful authentication in the IdP for Elasticsearch access and refresh tokens, which can be used for authentication against Elasticsearch.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/saml-guide-stack.html" + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/saml" }, "operationId": "security-saml-authenticate", "requestBody": { @@ -36545,7 +36545,7 @@ "summary": "Logout of SAML completely", "description": "Verifies the logout response sent from the SAML IdP.\n\nNOTE: This API is intended for use by custom web applications other than Kibana.\nIf you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.\n\nThe SAML IdP may send a logout response back to the SP after handling the SP-initiated SAML Single Logout.\nThis API verifies the response by ensuring the content is relevant and validating its signature.\nAn empty response is returned if the verification process is successful.\nThe response can be sent by the IdP with either the HTTP-Redirect or the HTTP-Post binding.\nThe caller of this API must prepare the request accordingly so that this API can handle either of them.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/saml-guide-stack.html" + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/saml" }, "operationId": "security-saml-complete-logout", "requestBody": { @@ -36610,7 +36610,7 @@ "summary": "Invalidate SAML", "description": "Submit a SAML LogoutRequest message to Elasticsearch for consumption.\n\nNOTE: This API is intended for use by custom web applications other than Kibana.\nIf you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.\n\nThe logout request comes from the SAML IdP during an IdP initiated Single Logout.\nThe custom web application can use this API to have Elasticsearch process the `LogoutRequest`.\nAfter successful validation of the request, Elasticsearch invalidates the access token and refresh token that corresponds to that specific SAML principal and provides a URL that contains a SAML LogoutResponse message.\nThus the user can be redirected back to their IdP.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/saml-guide-stack.html" + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/saml" }, "operationId": "security-saml-invalidate", "requestBody": { @@ -36694,7 +36694,7 @@ "summary": "Logout of SAML", "description": "Submits a request to invalidate an access token and refresh token.\n\nNOTE: This API is intended for use by custom web applications other than Kibana.\nIf you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.\n\nThis API invalidates the tokens that were generated for a user by the SAML authenticate API.\nIf the SAML realm in Elasticsearch is configured accordingly and the SAML IdP supports this, the Elasticsearch response contains a URL to redirect the user to the IdP that contains a SAML logout request (starting an SP-initiated SAML Single Logout).", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/saml-guide-stack.html" + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/saml" }, "operationId": "security-saml-logout", "requestBody": { @@ -36764,7 +36764,7 @@ "summary": "Prepare SAML authentication", "description": "Create a SAML authentication request (``) as a URL string based on the configuration of the respective SAML realm in Elasticsearch.\n\nNOTE: This API is intended for use by custom web applications other than Kibana.\nIf you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.\n\nThis API returns a URL pointing to the SAML Identity Provider.\nYou can use the URL to redirect the browser of the user in order to continue the authentication process.\nThe URL includes a single parameter named `SAMLRequest`, which contains a SAML Authentication request that is deflated and Base64 encoded.\nIf the configuration dictates that SAML authentication requests should be signed, the URL has two extra parameters named `SigAlg` and `Signature`.\nThese parameters contain the algorithm used for the signature and the signature value itself.\nIt also returns a random string that uniquely identifies this SAML Authentication request.\nThe caller of this API needs to store this identifier as it needs to be used in a following step of the authentication process.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/saml-guide-stack.html" + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/saml" }, "operationId": "security-saml-prepare-authentication", "requestBody": { @@ -37035,7 +37035,7 @@ "summary": "Update a cross-cluster API key", "description": "Update the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access.\n\nTo use this API, you must have at least the `manage_security` cluster privilege.\nUsers can only update API keys that they created.\nTo update another user's API key, use the `run_as` feature to submit a request on behalf of another user.\n\nIMPORTANT: It's not possible to use an API key as the authentication credential for this API.\nTo update an API key, the owner user's credentials are required.\n\nIt's not possible to update expired API keys, or API keys that have been invalidated by the invalidate API key API.\n\nThis API supports updates to an API key's access scope, metadata, and expiration.\nThe owner user's information, such as the `username` and `realm`, is also updated automatically on every call.\n\nNOTE: This API cannot update REST API keys, which should be updated by either the update API key or bulk update API keys API.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/remote-clusters-api-key.html" + "url": "https://www.elastic.co/docs/deploy-manage/remote-clusters/remote-clusters-api-key" }, "operationId": "security-update-cross-cluster-api-key", "parameters": [ @@ -38041,7 +38041,7 @@ "summary": "Clean up the snapshot repository", "description": "Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-register-repository.html#snapshots-repository-cleanup" + "url": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/self-managed#snapshots-repository-cleanup" }, "operationId": "snapshot-cleanup-repository", "parameters": [ @@ -38418,7 +38418,7 @@ "summary": "Create a snapshot", "description": "Take a snapshot of a cluster or of data streams and indices.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-take-snapshot.html" + "url": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/create-snapshots" }, "operationId": "snapshot-create", "parameters": [ @@ -38452,7 +38452,7 @@ "summary": "Create a snapshot", "description": "Take a snapshot of a cluster or of data streams and indices.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-take-snapshot.html" + "url": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/create-snapshots" }, "operationId": "snapshot-create-1", "parameters": [ @@ -38571,7 +38571,7 @@ "summary": "Create or update a snapshot repository", "description": "IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters.\nTo register a snapshot repository, the cluster's global metadata must be writeable.\nEnsure there are no cluster blocks (for example, `cluster.blocks.read_only` and `clsuter.blocks.read_only_allow_delete` settings) that prevent write access.\n\nSeveral options for this API can be specified using a query parameter or a request body parameter.\nIf both parameters are specified, only the query parameter is used.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-register-repository.html" + "url": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/self-managed" }, "operationId": "snapshot-create-repository", "parameters": [ @@ -38605,7 +38605,7 @@ "summary": "Create or update a snapshot repository", "description": "IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters.\nTo register a snapshot repository, the cluster's global metadata must be writeable.\nEnsure there are no cluster blocks (for example, `cluster.blocks.read_only` and `clsuter.blocks.read_only_allow_delete` settings) that prevent write access.\n\nSeveral options for this API can be specified using a query parameter or a request body parameter.\nIf both parameters are specified, only the query parameter is used.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-register-repository.html" + "url": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/self-managed" }, "operationId": "snapshot-create-repository-1", "parameters": [ @@ -39088,7 +39088,7 @@ "summary": "Restore a snapshot", "description": "Restore a snapshot of a cluster or data streams and indices.\n\nYou can restore a snapshot only to a running cluster with an elected master node.\nThe snapshot repository must be registered and available to the cluster.\nThe snapshot and cluster versions must be compatible.\n\nTo restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks.\n\nBefore you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API:\n\n```\nGET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream\n```\n\nIf no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices.\n\nIf your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-restore-snapshot.html" + "url": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/restore-snapshot" }, "operationId": "snapshot-restore", "parameters": [ @@ -39143,7 +39143,7 @@ "properties": { "feature_states": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshot-restore.html#feature-state" + "url": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore#feature-state" }, "description": "The feature states to restore.\nIf `include_global_state` is `true`, the request restores all feature states in the snapshot by default.\nIf `include_global_state` is `false`, the request restores no feature states by default.\nNote that specifying an empty array will result in the default behavior.\nTo restore no feature states, regardless of the `include_global_state` value, specify an array containing only the value `none` (`[\"none\"]`).", "type": "array", @@ -39320,7 +39320,7 @@ "summary": "Verify a snapshot repository", "description": "Check for common misconfigurations in a snapshot repository.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-register-repository.html#snapshots-repository-verification" + "url": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/self-managed#snapshots-repository-verification" }, "operationId": "snapshot-verify-repository", "parameters": [ @@ -39743,7 +39743,7 @@ "summary": "Get SSL certificates", "description": "Get information about the X.509 certificates that are used to encrypt communications in the cluster.\nThe API returns a list that includes certificates from all TLS contexts including:\n\n- Settings for transport and HTTP interfaces\n- TLS settings that are used within authentication realms\n- TLS settings for remote monitoring exporters\n\nThe list includes certificates that are used for configuring trust, such as those configured in the `xpack.security.transport.ssl.truststore` and `xpack.security.transport.ssl.certificate_authorities` settings.\nIt also includes certificates that are used for configuring server identity, such as `xpack.security.http.ssl.keystore` and `xpack.security.http.ssl.certificate settings`.\n\nThe list does not include certificates that are sourced from the default SSL context of the Java Runtime Environment (JRE), even if those certificates are in use within Elasticsearch.\n\nNOTE: When a PKCS#11 token is configured as the truststore of the JRE, the API returns all the certificates that are included in the PKCS#11 token irrespective of whether these are used in the Elasticsearch TLS configuration.\n\nIf Elasticsearch is configured to use a keystore or truststore, the API output includes all certificates in that store, even though some of the certificates might not be in active use within the cluster.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-basic-setup.html#encrypt-internode-communication" + "url": "https://www.elastic.co/docs/deploy-manage/security/set-up-basic-security#encrypt-internode-communication" }, "operationId": "ssl-certificates", "responses": { @@ -41394,7 +41394,7 @@ "summary": "Test a Grok pattern", "description": "Test a Grok pattern on one or more lines of text.\nThe API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/grok.html" + "url": "https://www.elastic.co/docs/explore-analyze/scripting/grok" }, "operationId": "text-structure-test-grok-pattern", "parameters": [ @@ -41419,7 +41419,7 @@ "summary": "Test a Grok pattern", "description": "Test a Grok pattern on one or more lines of text.\nThe API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/grok.html" + "url": "https://www.elastic.co/docs/explore-analyze/scripting/grok" }, "operationId": "text-structure-test-grok-pattern-1", "parameters": [ @@ -43277,7 +43277,7 @@ "summary": "Activate a watch", "description": "A watch can be either active or inactive.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/how-watcher-works.html" + "url": "https://www.elastic.co/docs/explore-analyze/alerts-cases/watcher/how-watcher-works" }, "operationId": "watcher-activate-watch", "parameters": [ @@ -43298,7 +43298,7 @@ "summary": "Activate a watch", "description": "A watch can be either active or inactive.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/how-watcher-works.html" + "url": "https://www.elastic.co/docs/explore-analyze/alerts-cases/watcher/how-watcher-works" }, "operationId": "watcher-activate-watch-1", "parameters": [ @@ -43321,7 +43321,7 @@ "summary": "Deactivate a watch", "description": "A watch can be either active or inactive.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/how-watcher-works.html" + "url": "https://www.elastic.co/docs/explore-analyze/alerts-cases/watcher/how-watcher-works" }, "operationId": "watcher-deactivate-watch", "parameters": [ @@ -43342,7 +43342,7 @@ "summary": "Deactivate a watch", "description": "A watch can be either active or inactive.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/how-watcher-works.html" + "url": "https://www.elastic.co/docs/explore-analyze/alerts-cases/watcher/how-watcher-works" }, "operationId": "watcher-deactivate-watch-1", "parameters": [ @@ -44284,7 +44284,7 @@ }, "_types.aggregations.Aggregate": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations.html" + "url": "https://www.elastic.co/docs/explore-analyze/query-filter/aggregations" }, "oneOf": [ { @@ -49644,7 +49644,7 @@ }, "_types.query_dsl.QueryContainer": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html" + "url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl" }, "description": "An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.", "type": "object", @@ -49684,7 +49684,7 @@ }, "fuzzy": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-fuzzy-query.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-fuzzy-query" }, "description": "Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance.", "type": "object", @@ -49726,7 +49726,7 @@ }, "intervals": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-intervals-query.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-intervals-query" }, "description": "Returns documents based on the order and proximity of matching terms.", "type": "object", @@ -49741,7 +49741,7 @@ }, "match": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query" }, "description": "Returns documents that match a provided text, number, date or boolean value.\nThe provided text is analyzed before matching.", "type": "object", @@ -49756,7 +49756,7 @@ }, "match_bool_prefix": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-bool-prefix-query.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-bool-prefix-query" }, "description": "Analyzes its input and constructs a `bool` query from the terms.\nEach term except the last is used in a `term` query.\nThe last term is used in a prefix query.", "type": "object", @@ -49771,7 +49771,7 @@ }, "match_phrase": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query-phrase.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query-phrase" }, "description": "Analyzes the text and creates a phrase query out of the analyzed text.", "type": "object", @@ -49783,7 +49783,7 @@ }, "match_phrase_prefix": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query-phrase-prefix.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query-phrase-prefix" }, "description": "Returns documents that contain the words of a provided text, in the same order as provided.\nThe last term of the provided text is treated as a prefix, matching any words that begin with that term.", "type": "object", @@ -49813,7 +49813,7 @@ }, "prefix": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-prefix-query.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-prefix-query" }, "description": "Returns documents that contain a specific prefix in a provided field.", "type": "object", @@ -49828,7 +49828,7 @@ }, "range": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-range-query" }, "description": "Returns documents that contain terms within a provided range.", "type": "object", @@ -49843,7 +49843,7 @@ }, "regexp": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-regexp-query.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-regexp-query" }, "description": "Returns documents that contain terms matching a regular expression.", "type": "object", @@ -49894,7 +49894,7 @@ }, "span_term": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-term-query.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-term-query" }, "description": "Matches spans containing a term.", "type": "object", @@ -49912,7 +49912,7 @@ }, "term": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-term-query.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-term-query" }, "description": "Returns documents that contain an exact term in a provided field.\nTo return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.", "type": "object", @@ -49927,7 +49927,7 @@ }, "terms_set": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-set-query.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-terms-set-query" }, "description": "Returns documents that contain a minimum number of exact terms in a provided field.\nTo return a document, a required number of terms must exactly match the field values, including whitespace and capitalization.", "type": "object", @@ -49940,7 +49940,7 @@ "text_expansion": { "deprecated": true, "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-text-expansion-query.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-text-expansion-query" }, "description": "Uses a natural language processing model to convert the query text into a list of token-weight pairs which are then used in a query against a sparse vector or rank features field.", "type": "object", @@ -49953,7 +49953,7 @@ "weighted_tokens": { "deprecated": true, "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-weighted-tokens-query.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-weighted-tokens-query" }, "description": "Supports returning text_expansion query results by sending in precomputed tokens with the query.", "type": "object", @@ -49965,7 +49965,7 @@ }, "wildcard": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-wildcard-query.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-wildcard-query" }, "description": "Returns documents that contain terms matching a wildcard pattern.", "type": "object", @@ -50239,7 +50239,7 @@ }, "_types.query_dsl.DistanceFeatureQuery": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-distance-feature-query.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-distance-feature-query" }, "oneOf": [ { @@ -50710,7 +50710,7 @@ }, "indices_boost": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html#relevance-scores" + "url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl#relevance-scores" }, "description": "Boost the `_score` of documents from specified indices.\nThe boost value is the factor by which scores are multiplied.\nA boost value greater than `1.0` increases the score.\nA boost value between `0` and `1.0` decreases the score.", "type": "array", @@ -50725,7 +50725,7 @@ }, "docvalue_fields": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-fields.html#docvalue-fields" + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#docvalue-fields" }, "description": "An array of wildcard (`*`) field patterns.\nThe request returns doc values for field names matching these patterns in the `hits.fields` property of the response.", "type": "array", @@ -50735,7 +50735,7 @@ }, "knn": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/knn-search.html#approximate-knn" + "url": "https://www.elastic.co/docs/solutions/search/vector/knn#approximate-knn" }, "description": "The approximate kNN search to run.", "oneOf": [ @@ -50835,7 +50835,7 @@ }, "seq_no_primary_term": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/optimistic-concurrency-control.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control" }, "description": "If `true`, the request returns sequence number and primary term of the last modification of each hit.", "type": "boolean" @@ -52227,7 +52227,7 @@ }, { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-intervals-query.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-intervals-query" }, "type": "object", "properties": { @@ -52729,7 +52729,7 @@ "properties": { "analyzer": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html" + "url": "https://www.elastic.co/docs/manage-data/data-store/text-analysis" }, "description": "The analyzer that is used to analyze the free form text.\nDefaults to the analyzer associated with the first field in fields.", "type": "string" @@ -53095,7 +53095,7 @@ }, { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-pinned-query.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-pinned-query" }, "allOf": [ { @@ -53288,7 +53288,7 @@ }, "_types.query_dsl.RangeQuery": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-range-query" }, "oneOf": [ { @@ -54211,7 +54211,7 @@ }, { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-sparse-vector-query.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-sparse-vector-query" }, "allOf": [ { @@ -57513,7 +57513,7 @@ }, "deciders": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-deciders.html" + "url": "https://www.elastic.co/docs/deploy-manage/autoscaling/autoscaling-deciders" }, "description": "Decider settings.", "type": "object", @@ -63409,7 +63409,7 @@ }, "_types.analysis.CharFilter": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-charfilters.html" + "url": "https://www.elastic.co/docs/reference/text-analysis/character-filter-reference" }, "oneOf": [ { @@ -63596,7 +63596,7 @@ }, "_types.analysis.TokenFilter": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenfilters.html" + "url": "https://www.elastic.co/docs/reference/text-analysis/token-filter-reference" }, "oneOf": [ { @@ -65455,7 +65455,7 @@ }, "_types.analysis.Tokenizer": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenizers.html" + "url": "https://www.elastic.co/docs/reference/text-analysis/tokenizer-reference" }, "oneOf": [ { @@ -79222,7 +79222,7 @@ }, "model_id": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/machine-learning/current/ml-nlp-import-model.html#ml-nlp-import-script" + "url": "https://www.elastic.co/docs/explore-analyze/machine-learning/nlp/ml-nlp-import-model#ml-nlp-import-script" }, "description": "The name of the model to use for the inference task.\nIt can be the ID of a built-in model (for example, `.multilingual-e5-small` for E5) or a text embedding model that was uploaded by using the Eland client.", "type": "string" @@ -82300,7 +82300,7 @@ }, "pipeline": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/logstash/current/configuration-file-structure.html" + "url": "https://www.elastic.co/docs/reference/logstash/configuration-file-structure" }, "description": "The configuration for the pipeline.", "type": "string" @@ -92398,7 +92398,7 @@ }, "run_as": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/run-as-privilege.html" + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/submitting-requests-on-behalf-of-other-users" }, "description": "A list of users that the API keys can impersonate.\nNOTE: In Elastic Cloud Serverless, the run-as feature is disabled.\nFor API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected.", "type": "array", @@ -93375,7 +93375,7 @@ }, "run_as": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/run-as-privilege.html" + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/submitting-requests-on-behalf-of-other-users" }, "description": "A list of users that the API keys can impersonate.", "type": "array", @@ -93567,7 +93567,7 @@ "properties": { "field_security": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/field-and-document-access-control.html" + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level" }, "description": "The document fields that the owners of the role have read access to.", "type": "array", @@ -93619,7 +93619,7 @@ "properties": { "field_security": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/field-and-document-access-control.html" + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level" }, "description": "The document fields that the owners of the role have read access to.", "type": "array", @@ -94841,7 +94841,7 @@ "properties": { "type": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/repository-azure.html" + "url": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/azure-repository" }, "description": "The Azure repository type.", "type": "string", @@ -94935,7 +94935,7 @@ "properties": { "type": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/repository-gcs.html" + "url": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/google-cloud-storage-repository" }, "description": "The Google Cloud Storage repository type.", "type": "string", @@ -95000,7 +95000,7 @@ "properties": { "type": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/repository-s3.html" + "url": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/s3-repository" }, "description": "The S3 repository type.", "type": "string", @@ -95083,7 +95083,7 @@ }, "storage_class": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/repository-s3.html#repository-s3-storage-classes" + "url": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/s3-repository#repository-s3-storage-classes" }, "description": "The S3 storage class for objects written to the repository.\nValues may be `standard`, `reduced_redundancy`, `standard_ia`, `onezone_ia`, and `intelligent_tiering`.", "type": "string" @@ -95115,7 +95115,7 @@ "properties": { "type": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-filesystem-repository.html" + "url": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/shared-file-system-repository" }, "description": "The shared file system repository type.", "type": "string", @@ -95171,7 +95171,7 @@ "properties": { "type": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-read-only-repository.html" + "url": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/read-only-url-repository" }, "description": "The read-only URL repository type.", "type": "string", @@ -95230,7 +95230,7 @@ "properties": { "type": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-source-only-repository.html" + "url": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/source-only-repository" }, "description": "The source-only repository type.", "type": "string", @@ -107479,7 +107479,7 @@ "fleet.msearch-allow_partial_search_results": { "in": "query", "name": "allow_partial_search_results", - "description": "If true, returns partial results if there are shard request timeouts or [shard failures](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-replication.html#shard-failures). If false, returns\nan error with no partial results. Defaults to the configured cluster setting `search.default_allow_partial_results`\nwhich is true by default.", + "description": "If true, returns partial results if there are shard request timeouts or shard failures.\nIf false, returns an error with no partial results.\nDefaults to the configured cluster setting `search.default_allow_partial_results`, which is true by default.", "deprecated": false, "schema": { "type": "boolean" @@ -107904,7 +107904,7 @@ "fleet.search-allow_partial_search_results": { "in": "query", "name": "allow_partial_search_results", - "description": "If true, returns partial results if there are shard request timeouts or [shard failures](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-replication.html#shard-failures). If false, returns\nan error with no partial results. Defaults to the configured cluster setting `search.default_allow_partial_results`\nwhich is true by default.", + "description": "If true, returns partial results if there are shard request timeouts or shard failures.\nIf false, returns an error with no partial results.\nDefaults to the configured cluster setting `search.default_allow_partial_results`, which is true by default.", "deprecated": false, "schema": { "type": "boolean" @@ -116578,7 +116578,7 @@ "properties": { "aggregations": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-agg-limitations.html" + "url": "https://www.elastic.co/docs/manage-data/lifecycle/rollup/rollup-aggregation-limitations" }, "description": "Specifies aggregations.", "type": "object", @@ -116707,7 +116707,7 @@ }, "indices_boost": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html#relevance-scores" + "url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl#relevance-scores" }, "description": "Boost the `_score` of documents from specified indices.\nThe boost value is the factor by which scores are multiplied.\nA boost value greater than `1.0` increases the score.\nA boost value between `0` and `1.0` decreases the score.", "type": "array", @@ -116722,7 +116722,7 @@ }, "docvalue_fields": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-fields.html#docvalue-fields" + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#docvalue-fields" }, "description": "An array of wildcard (`*`) field patterns.\nThe request returns doc values for field names matching these patterns in the `hits.fields` property of the response.", "type": "array", @@ -116732,7 +116732,7 @@ }, "knn": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/knn-search.html#approximate-knn" + "url": "https://www.elastic.co/docs/solutions/search/vector/knn#approximate-knn" }, "description": "The approximate kNN search to run.", "oneOf": [ @@ -116832,7 +116832,7 @@ }, "seq_no_primary_term": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/optimistic-concurrency-control.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control" }, "description": "If `true`, the request returns sequence number and primary term of the last modification of each hit.", "type": "boolean" @@ -117219,7 +117219,7 @@ }, "run_as": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/run-as-privilege.html" + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/submitting-requests-on-behalf-of-other-users" }, "description": "A list of users that the owners of this role can impersonate. *Note*: in Serverless, the run-as feature is disabled. For API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected.", "type": "array", @@ -117391,7 +117391,7 @@ }, "password_hash": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-settings.html#hashing-settings" + "url": "https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/security-settings#hashing-settings" }, "description": "A hash of the user's password.\nThis must be produced using the same hashing algorithm as has been configured for password storage.\nFor more details, see the explanation of the `xpack.security.authc.password_hashing.algorithm` setting in the user cache and password hash algorithm documentation.\nUsing this parameter allows the client to pre-hash the password for performance and/or confidentiality reasons.\nThe `password` parameter and the `password_hash` parameter cannot be used in the same request.", "type": "string" @@ -117704,7 +117704,7 @@ }, "feature_states": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshot-restore.html#feature-state" + "url": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore#feature-state" }, "description": "The feature states to include in the snapshot.\nEach feature state includes one or more system indices containing related data.\nYou can view a list of eligible features using the get features API.\n\nIf `include_global_state` is `true`, all current feature states are included by default.\nIf `include_global_state` is `false`, no feature states are included by default.\n\nNote that specifying an empty array will result in the default behavior.\nTo exclude all feature states, regardless of the `include_global_state` value, specify an array with only the value `none` (`[\"none\"]`).", "type": "array", @@ -117799,7 +117799,7 @@ }, "columnar": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-rest-columnar.html" + "url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/sql-rest-columnar" }, "description": "If `true`, the results are in a columnar fashion: one row represents all the values of a certain column from the current page of results.\nThe API supports this parameter only for CBOR, JSON, SMILE, and YAML responses.", "type": "boolean" @@ -117842,7 +117842,7 @@ }, "query": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-spec.html" + "url": "https://www.elastic.co/docs/reference/query-languages/sql/sql-spec" }, "description": "The SQL query to run.", "type": "string" diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index e28668ea9d..de81fb6334 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -1358,7 +1358,7 @@ "summary": "Run a scrolling search", "description": "IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the `search_after` parameter with a point in time (PIT).\n\nThe scroll API gets large sets of results from a single scrolling search request.\nTo get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter.\nThe `scroll` parameter indicates how long Elasticsearch should retain the search context for the request.\nThe search response returns a scroll ID in the `_scroll_id` response body parameter.\nYou can then use the scroll ID with the scroll API to retrieve the next batch of results for the request.\nIf the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.\n\nYou can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.\n\nIMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results" + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#scroll-search-results" }, "operationId": "scroll", "parameters": [ @@ -1388,7 +1388,7 @@ "summary": "Run a scrolling search", "description": "IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the `search_after` parameter with a point in time (PIT).\n\nThe scroll API gets large sets of results from a single scrolling search request.\nTo get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter.\nThe `scroll` parameter indicates how long Elasticsearch should retain the search context for the request.\nThe search response returns a scroll ID in the `_scroll_id` response body parameter.\nYou can then use the scroll ID with the scroll API to retrieve the next batch of results for the request.\nIf the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.\n\nYou can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.\n\nIMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results" + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#scroll-search-results" }, "operationId": "scroll-1", "parameters": [ @@ -1418,7 +1418,7 @@ "summary": "Clear a scrolling search", "description": "Clear the search context and results for a scrolling search.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results" + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#scroll-search-results" }, "operationId": "clear-scroll", "requestBody": { @@ -1439,7 +1439,7 @@ "summary": "Run a scrolling search", "description": "IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the `search_after` parameter with a point in time (PIT).\n\nThe scroll API gets large sets of results from a single scrolling search request.\nTo get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter.\nThe `scroll` parameter indicates how long Elasticsearch should retain the search context for the request.\nThe search response returns a scroll ID in the `_scroll_id` response body parameter.\nYou can then use the scroll ID with the scroll API to retrieve the next batch of results for the request.\nIf the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.\n\nYou can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.\n\nIMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results" + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#scroll-search-results" }, "operationId": "scroll-2", "parameters": [ @@ -1472,7 +1472,7 @@ "summary": "Run a scrolling search", "description": "IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the `search_after` parameter with a point in time (PIT).\n\nThe scroll API gets large sets of results from a single scrolling search request.\nTo get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter.\nThe `scroll` parameter indicates how long Elasticsearch should retain the search context for the request.\nThe search response returns a scroll ID in the `_scroll_id` response body parameter.\nYou can then use the scroll ID with the scroll API to retrieve the next batch of results for the request.\nIf the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.\n\nYou can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.\n\nIMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results" + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#scroll-search-results" }, "operationId": "scroll-3", "parameters": [ @@ -1505,7 +1505,7 @@ "summary": "Clear a scrolling search", "description": "Clear the search context and results for a scrolling search.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results" + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#scroll-search-results" }, "operationId": "clear-scroll-1", "parameters": [ @@ -3686,7 +3686,7 @@ "summary": "Create a new document in the index", "description": "You can index a new JSON document with the `//_doc/` or `//_create/<_id>` APIs\nUsing `_create` guarantees that the document is indexed only if it does not already exist.\nIt returns a 409 response when a document with a same ID already exists in the index.\nTo update an existing document, you must use the `//_doc/` API.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:\n\n* To add a document using the `PUT //_create/<_id>` or `POST //_create/<_id>` request formats, you must have the `create_doc`, `create`, `index`, or `write` index privilege.\n* To automatically create a data stream or index with this API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege.\n\nAutomatic data stream creation requires a matching index template with data stream enabled.\n\n**Automatically create data streams and indices**\n\nIf the request's target doesn't exist and matches an index template with a `data_stream` definition, the index operation automatically creates the data stream.\n\nIf the target doesn't exist and doesn't match a data stream template, the operation automatically creates the index and applies any matching index templates.\n\nNOTE: Elasticsearch includes several built-in index templates. To avoid naming collisions with these templates, refer to index pattern documentation.\n\nIf no mapping exists, the index operation creates a dynamic mapping.\nBy default, new fields and objects are automatically added to the mapping if needed.\n\nAutomatic index creation is controlled by the `action.auto_create_index` setting.\nIf it is `true`, any index can be created automatically.\nYou can modify this setting to explicitly allow or block automatic creation of indices that match specified patterns or set it to `false` to turn off automatic index creation entirely.\nSpecify a comma-separated list of patterns you want to allow or prefix each pattern with `+` or `-` to indicate whether it should be allowed or blocked.\nWhen a list is specified, the default behaviour is to disallow.\n\nNOTE: The `action.auto_create_index` setting affects the automatic creation of indices only.\nIt does not affect the creation of data streams.\n\n**Routing**\n\nBy default, shard placement — or routing — is controlled by using a hash of the document's ID value.\nFor more explicit control, the value fed into the hash function used by the router can be directly specified on a per-operation basis using the `routing` parameter.\n\nWhen setting up explicit mapping, you can also use the `_routing` field to direct the index operation to extract the routing value from the document itself.\nThis does come at the (very minimal) cost of an additional document parsing pass.\nIf the `_routing` mapping is defined and set to be required, the index operation will fail if no routing value is provided or extracted.\n\nNOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template.\n\n**Distributed**\n\nThe index operation is directed to the primary shard based on its route and performed on the actual node containing this shard.\nAfter the primary shard completes the operation, if needed, the update is distributed to applicable replicas.\n\n**Active shards**\n\nTo improve the resiliency of writes to the system, indexing operations can be configured to wait for a certain number of active shard copies before proceeding with the operation.\nIf the requisite number of active shard copies are not available, then the write operation must wait and retry, until either the requisite shard copies have started or a timeout occurs.\nBy default, write operations only wait for the primary shards to be active before proceeding (that is to say `wait_for_active_shards` is `1`).\nThis default can be overridden in the index settings dynamically by setting `index.write.wait_for_active_shards`.\nTo alter this behavior per operation, use the `wait_for_active_shards request` parameter.\n\nValid values are all or any positive integer up to the total number of configured copies per shard in the index (which is `number_of_replicas`+1).\nSpecifying a negative value or a number greater than the number of shard copies will throw an error.\n\nFor example, suppose you have a cluster of three nodes, A, B, and C and you create an index index with the number of replicas set to 3 (resulting in 4 shard copies, one more copy than there are nodes).\nIf you attempt an indexing operation, by default the operation will only ensure the primary copy of each shard is available before proceeding.\nThis means that even if B and C went down and A hosted the primary shard copies, the indexing operation would still proceed with only one copy of the data.\nIf `wait_for_active_shards` is set on the request to `3` (and all three nodes are up), the indexing operation will require 3 active shard copies before proceeding.\nThis requirement should be met because there are 3 active nodes in the cluster, each one holding a copy of the shard.\nHowever, if you set `wait_for_active_shards` to `all` (or to `4`, which is the same in this situation), the indexing operation will not proceed as you do not have all 4 copies of each shard active in the index.\nThe operation will timeout unless a new node is brought up in the cluster to host the fourth copy of the shard.\n\nIt is important to note that this setting greatly reduces the chances of the write operation not writing to the requisite number of shard copies, but it does not completely eliminate the possibility, because this check occurs before the write operation starts.\nAfter the write operation is underway, it is still possible for replication to fail on any number of shard copies but still succeed on the primary.\nThe `_shards` section of the API response reveals the number of shard copies on which replication succeeded and failed.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html" + "url": "https://www.elastic.co/docs/manage-data/data-store/data-streams" }, "operationId": "create", "parameters": [ @@ -3753,7 +3753,7 @@ "summary": "Create a new document in the index", "description": "You can index a new JSON document with the `//_doc/` or `//_create/<_id>` APIs\nUsing `_create` guarantees that the document is indexed only if it does not already exist.\nIt returns a 409 response when a document with a same ID already exists in the index.\nTo update an existing document, you must use the `//_doc/` API.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:\n\n* To add a document using the `PUT //_create/<_id>` or `POST //_create/<_id>` request formats, you must have the `create_doc`, `create`, `index`, or `write` index privilege.\n* To automatically create a data stream or index with this API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege.\n\nAutomatic data stream creation requires a matching index template with data stream enabled.\n\n**Automatically create data streams and indices**\n\nIf the request's target doesn't exist and matches an index template with a `data_stream` definition, the index operation automatically creates the data stream.\n\nIf the target doesn't exist and doesn't match a data stream template, the operation automatically creates the index and applies any matching index templates.\n\nNOTE: Elasticsearch includes several built-in index templates. To avoid naming collisions with these templates, refer to index pattern documentation.\n\nIf no mapping exists, the index operation creates a dynamic mapping.\nBy default, new fields and objects are automatically added to the mapping if needed.\n\nAutomatic index creation is controlled by the `action.auto_create_index` setting.\nIf it is `true`, any index can be created automatically.\nYou can modify this setting to explicitly allow or block automatic creation of indices that match specified patterns or set it to `false` to turn off automatic index creation entirely.\nSpecify a comma-separated list of patterns you want to allow or prefix each pattern with `+` or `-` to indicate whether it should be allowed or blocked.\nWhen a list is specified, the default behaviour is to disallow.\n\nNOTE: The `action.auto_create_index` setting affects the automatic creation of indices only.\nIt does not affect the creation of data streams.\n\n**Routing**\n\nBy default, shard placement — or routing — is controlled by using a hash of the document's ID value.\nFor more explicit control, the value fed into the hash function used by the router can be directly specified on a per-operation basis using the `routing` parameter.\n\nWhen setting up explicit mapping, you can also use the `_routing` field to direct the index operation to extract the routing value from the document itself.\nThis does come at the (very minimal) cost of an additional document parsing pass.\nIf the `_routing` mapping is defined and set to be required, the index operation will fail if no routing value is provided or extracted.\n\nNOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template.\n\n**Distributed**\n\nThe index operation is directed to the primary shard based on its route and performed on the actual node containing this shard.\nAfter the primary shard completes the operation, if needed, the update is distributed to applicable replicas.\n\n**Active shards**\n\nTo improve the resiliency of writes to the system, indexing operations can be configured to wait for a certain number of active shard copies before proceeding with the operation.\nIf the requisite number of active shard copies are not available, then the write operation must wait and retry, until either the requisite shard copies have started or a timeout occurs.\nBy default, write operations only wait for the primary shards to be active before proceeding (that is to say `wait_for_active_shards` is `1`).\nThis default can be overridden in the index settings dynamically by setting `index.write.wait_for_active_shards`.\nTo alter this behavior per operation, use the `wait_for_active_shards request` parameter.\n\nValid values are all or any positive integer up to the total number of configured copies per shard in the index (which is `number_of_replicas`+1).\nSpecifying a negative value or a number greater than the number of shard copies will throw an error.\n\nFor example, suppose you have a cluster of three nodes, A, B, and C and you create an index index with the number of replicas set to 3 (resulting in 4 shard copies, one more copy than there are nodes).\nIf you attempt an indexing operation, by default the operation will only ensure the primary copy of each shard is available before proceeding.\nThis means that even if B and C went down and A hosted the primary shard copies, the indexing operation would still proceed with only one copy of the data.\nIf `wait_for_active_shards` is set on the request to `3` (and all three nodes are up), the indexing operation will require 3 active shard copies before proceeding.\nThis requirement should be met because there are 3 active nodes in the cluster, each one holding a copy of the shard.\nHowever, if you set `wait_for_active_shards` to `all` (or to `4`, which is the same in this situation), the indexing operation will not proceed as you do not have all 4 copies of each shard active in the index.\nThe operation will timeout unless a new node is brought up in the cluster to host the fourth copy of the shard.\n\nIt is important to note that this setting greatly reduces the chances of the write operation not writing to the requisite number of shard copies, but it does not completely eliminate the possibility, because this check occurs before the write operation starts.\nAfter the write operation is underway, it is still possible for replication to fail on any number of shard copies but still succeed on the primary.\nThe `_shards` section of the API response reveals the number of shard copies on which replication succeeded and failed.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html" + "url": "https://www.elastic.co/docs/manage-data/data-store/data-streams" }, "operationId": "create-1", "parameters": [ @@ -3983,7 +3983,7 @@ "summary": "Create or update a document in an index", "description": "Add a JSON document to the specified data stream or index and make it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.\n\nNOTE: You cannot use this API to send update requests for existing documents in a data stream.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:\n\n* To add or overwrite a document using the `PUT //_doc/<_id>` request format, you must have the `create`, `index`, or `write` index privilege.\n* To add a document using the `POST //_doc/` request format, you must have the `create_doc`, `create`, `index`, or `write` index privilege.\n* To automatically create a data stream or index with this API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege.\n\nAutomatic data stream creation requires a matching index template with data stream enabled.\n\nNOTE: Replica shards might not all be started when an indexing operation returns successfully.\nBy default, only the primary is required. Set `wait_for_active_shards` to change this default behavior.\n\n**Automatically create data streams and indices**\n\nIf the request's target doesn't exist and matches an index template with a `data_stream` definition, the index operation automatically creates the data stream.\n\nIf the target doesn't exist and doesn't match a data stream template, the operation automatically creates the index and applies any matching index templates.\n\nNOTE: Elasticsearch includes several built-in index templates. To avoid naming collisions with these templates, refer to index pattern documentation.\n\nIf no mapping exists, the index operation creates a dynamic mapping.\nBy default, new fields and objects are automatically added to the mapping if needed.\n\nAutomatic index creation is controlled by the `action.auto_create_index` setting.\nIf it is `true`, any index can be created automatically.\nYou can modify this setting to explicitly allow or block automatic creation of indices that match specified patterns or set it to `false` to turn off automatic index creation entirely.\nSpecify a comma-separated list of patterns you want to allow or prefix each pattern with `+` or `-` to indicate whether it should be allowed or blocked.\nWhen a list is specified, the default behaviour is to disallow.\n\nNOTE: The `action.auto_create_index` setting affects the automatic creation of indices only.\nIt does not affect the creation of data streams.\n\n**Optimistic concurrency control**\n\nIndex operations can be made conditional and only be performed if the last modification to the document was assigned the sequence number and primary term specified by the `if_seq_no` and `if_primary_term` parameters.\nIf a mismatch is detected, the operation will result in a `VersionConflictException` and a status code of `409`.\n\n**Routing**\n\nBy default, shard placement — or routing — is controlled by using a hash of the document's ID value.\nFor more explicit control, the value fed into the hash function used by the router can be directly specified on a per-operation basis using the `routing` parameter.\n\nWhen setting up explicit mapping, you can also use the `_routing` field to direct the index operation to extract the routing value from the document itself.\nThis does come at the (very minimal) cost of an additional document parsing pass.\nIf the `_routing` mapping is defined and set to be required, the index operation will fail if no routing value is provided or extracted.\n\nNOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template.\n\n**Distributed**\n\nThe index operation is directed to the primary shard based on its route and performed on the actual node containing this shard.\nAfter the primary shard completes the operation, if needed, the update is distributed to applicable replicas.\n\n**Active shards**\n\nTo improve the resiliency of writes to the system, indexing operations can be configured to wait for a certain number of active shard copies before proceeding with the operation.\nIf the requisite number of active shard copies are not available, then the write operation must wait and retry, until either the requisite shard copies have started or a timeout occurs.\nBy default, write operations only wait for the primary shards to be active before proceeding (that is to say `wait_for_active_shards` is `1`).\nThis default can be overridden in the index settings dynamically by setting `index.write.wait_for_active_shards`.\nTo alter this behavior per operation, use the `wait_for_active_shards request` parameter.\n\nValid values are all or any positive integer up to the total number of configured copies per shard in the index (which is `number_of_replicas`+1).\nSpecifying a negative value or a number greater than the number of shard copies will throw an error.\n\nFor example, suppose you have a cluster of three nodes, A, B, and C and you create an index index with the number of replicas set to 3 (resulting in 4 shard copies, one more copy than there are nodes).\nIf you attempt an indexing operation, by default the operation will only ensure the primary copy of each shard is available before proceeding.\nThis means that even if B and C went down and A hosted the primary shard copies, the indexing operation would still proceed with only one copy of the data.\nIf `wait_for_active_shards` is set on the request to `3` (and all three nodes are up), the indexing operation will require 3 active shard copies before proceeding.\nThis requirement should be met because there are 3 active nodes in the cluster, each one holding a copy of the shard.\nHowever, if you set `wait_for_active_shards` to `all` (or to `4`, which is the same in this situation), the indexing operation will not proceed as you do not have all 4 copies of each shard active in the index.\nThe operation will timeout unless a new node is brought up in the cluster to host the fourth copy of the shard.\n\nIt is important to note that this setting greatly reduces the chances of the write operation not writing to the requisite number of shard copies, but it does not completely eliminate the possibility, because this check occurs before the write operation starts.\nAfter the write operation is underway, it is still possible for replication to fail on any number of shard copies but still succeed on the primary.\nThe `_shards` section of the API response reveals the number of shard copies on which replication succeeded and failed.\n\n**No operation (noop) updates**\n\nWhen updating a document by using this API, a new version of the document is always created even if the document hasn't changed.\nIf this isn't acceptable use the `_update` API with `detect_noop` set to `true`.\nThe `detect_noop` option isn't available on this API because it doesn’t fetch the old source and isn't able to compare it against the new source.\n\nThere isn't a definitive rule for when noop updates aren't acceptable.\nIt's a combination of lots of factors like how frequently your data source sends updates that are actually noops and how many queries per second Elasticsearch runs on the shard receiving the updates.\n\n**Versioning**\n\nEach indexed document is given a version number.\nBy default, internal versioning is used that starts at 1 and increments with each update, deletes included.\nOptionally, the version number can be set to an external value (for example, if maintained in a database).\nTo enable this functionality, `version_type` should be set to `external`.\nThe value provided must be a numeric, long value greater than or equal to 0, and less than around `9.2e+18`.\n\nNOTE: Versioning is completely real time, and is not affected by the near real time aspects of search operations.\nIf no version is provided, the operation runs without any version checks.\n\nWhen using the external version type, the system checks to see if the version number passed to the index request is greater than the version of the currently stored document.\nIf true, the document will be indexed and the new version number used.\nIf the value provided is less than or equal to the stored document's version number, a version conflict will occur and the index operation will fail. For example:\n\n```\nPUT my-index-000001/_doc/1?version=2&version_type=external\n{\n \"user\": {\n \"id\": \"elkbee\"\n }\n}\n\nIn this example, the operation will succeed since the supplied version of 2 is higher than the current document version of 1.\nIf the document was already updated and its version was set to 2 or higher, the indexing command will fail and result in a conflict (409 HTTP status code).\n\nA nice side effect is that there is no need to maintain strict ordering of async indexing operations run as a result of changes to a source database, as long as version numbers from the source database are used.\nEven the simple case of updating the Elasticsearch index using data from a database is simplified if external versioning is used, as only the latest version will be used if the index operations arrive out of order.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html" + "url": "https://www.elastic.co/docs/manage-data/data-store/data-streams" }, "operationId": "index", "parameters": [ @@ -4046,7 +4046,7 @@ "summary": "Create or update a document in an index", "description": "Add a JSON document to the specified data stream or index and make it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.\n\nNOTE: You cannot use this API to send update requests for existing documents in a data stream.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:\n\n* To add or overwrite a document using the `PUT //_doc/<_id>` request format, you must have the `create`, `index`, or `write` index privilege.\n* To add a document using the `POST //_doc/` request format, you must have the `create_doc`, `create`, `index`, or `write` index privilege.\n* To automatically create a data stream or index with this API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege.\n\nAutomatic data stream creation requires a matching index template with data stream enabled.\n\nNOTE: Replica shards might not all be started when an indexing operation returns successfully.\nBy default, only the primary is required. Set `wait_for_active_shards` to change this default behavior.\n\n**Automatically create data streams and indices**\n\nIf the request's target doesn't exist and matches an index template with a `data_stream` definition, the index operation automatically creates the data stream.\n\nIf the target doesn't exist and doesn't match a data stream template, the operation automatically creates the index and applies any matching index templates.\n\nNOTE: Elasticsearch includes several built-in index templates. To avoid naming collisions with these templates, refer to index pattern documentation.\n\nIf no mapping exists, the index operation creates a dynamic mapping.\nBy default, new fields and objects are automatically added to the mapping if needed.\n\nAutomatic index creation is controlled by the `action.auto_create_index` setting.\nIf it is `true`, any index can be created automatically.\nYou can modify this setting to explicitly allow or block automatic creation of indices that match specified patterns or set it to `false` to turn off automatic index creation entirely.\nSpecify a comma-separated list of patterns you want to allow or prefix each pattern with `+` or `-` to indicate whether it should be allowed or blocked.\nWhen a list is specified, the default behaviour is to disallow.\n\nNOTE: The `action.auto_create_index` setting affects the automatic creation of indices only.\nIt does not affect the creation of data streams.\n\n**Optimistic concurrency control**\n\nIndex operations can be made conditional and only be performed if the last modification to the document was assigned the sequence number and primary term specified by the `if_seq_no` and `if_primary_term` parameters.\nIf a mismatch is detected, the operation will result in a `VersionConflictException` and a status code of `409`.\n\n**Routing**\n\nBy default, shard placement — or routing — is controlled by using a hash of the document's ID value.\nFor more explicit control, the value fed into the hash function used by the router can be directly specified on a per-operation basis using the `routing` parameter.\n\nWhen setting up explicit mapping, you can also use the `_routing` field to direct the index operation to extract the routing value from the document itself.\nThis does come at the (very minimal) cost of an additional document parsing pass.\nIf the `_routing` mapping is defined and set to be required, the index operation will fail if no routing value is provided or extracted.\n\nNOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template.\n\n**Distributed**\n\nThe index operation is directed to the primary shard based on its route and performed on the actual node containing this shard.\nAfter the primary shard completes the operation, if needed, the update is distributed to applicable replicas.\n\n**Active shards**\n\nTo improve the resiliency of writes to the system, indexing operations can be configured to wait for a certain number of active shard copies before proceeding with the operation.\nIf the requisite number of active shard copies are not available, then the write operation must wait and retry, until either the requisite shard copies have started or a timeout occurs.\nBy default, write operations only wait for the primary shards to be active before proceeding (that is to say `wait_for_active_shards` is `1`).\nThis default can be overridden in the index settings dynamically by setting `index.write.wait_for_active_shards`.\nTo alter this behavior per operation, use the `wait_for_active_shards request` parameter.\n\nValid values are all or any positive integer up to the total number of configured copies per shard in the index (which is `number_of_replicas`+1).\nSpecifying a negative value or a number greater than the number of shard copies will throw an error.\n\nFor example, suppose you have a cluster of three nodes, A, B, and C and you create an index index with the number of replicas set to 3 (resulting in 4 shard copies, one more copy than there are nodes).\nIf you attempt an indexing operation, by default the operation will only ensure the primary copy of each shard is available before proceeding.\nThis means that even if B and C went down and A hosted the primary shard copies, the indexing operation would still proceed with only one copy of the data.\nIf `wait_for_active_shards` is set on the request to `3` (and all three nodes are up), the indexing operation will require 3 active shard copies before proceeding.\nThis requirement should be met because there are 3 active nodes in the cluster, each one holding a copy of the shard.\nHowever, if you set `wait_for_active_shards` to `all` (or to `4`, which is the same in this situation), the indexing operation will not proceed as you do not have all 4 copies of each shard active in the index.\nThe operation will timeout unless a new node is brought up in the cluster to host the fourth copy of the shard.\n\nIt is important to note that this setting greatly reduces the chances of the write operation not writing to the requisite number of shard copies, but it does not completely eliminate the possibility, because this check occurs before the write operation starts.\nAfter the write operation is underway, it is still possible for replication to fail on any number of shard copies but still succeed on the primary.\nThe `_shards` section of the API response reveals the number of shard copies on which replication succeeded and failed.\n\n**No operation (noop) updates**\n\nWhen updating a document by using this API, a new version of the document is always created even if the document hasn't changed.\nIf this isn't acceptable use the `_update` API with `detect_noop` set to `true`.\nThe `detect_noop` option isn't available on this API because it doesn’t fetch the old source and isn't able to compare it against the new source.\n\nThere isn't a definitive rule for when noop updates aren't acceptable.\nIt's a combination of lots of factors like how frequently your data source sends updates that are actually noops and how many queries per second Elasticsearch runs on the shard receiving the updates.\n\n**Versioning**\n\nEach indexed document is given a version number.\nBy default, internal versioning is used that starts at 1 and increments with each update, deletes included.\nOptionally, the version number can be set to an external value (for example, if maintained in a database).\nTo enable this functionality, `version_type` should be set to `external`.\nThe value provided must be a numeric, long value greater than or equal to 0, and less than around `9.2e+18`.\n\nNOTE: Versioning is completely real time, and is not affected by the near real time aspects of search operations.\nIf no version is provided, the operation runs without any version checks.\n\nWhen using the external version type, the system checks to see if the version number passed to the index request is greater than the version of the currently stored document.\nIf true, the document will be indexed and the new version number used.\nIf the value provided is less than or equal to the stored document's version number, a version conflict will occur and the index operation will fail. For example:\n\n```\nPUT my-index-000001/_doc/1?version=2&version_type=external\n{\n \"user\": {\n \"id\": \"elkbee\"\n }\n}\n\nIn this example, the operation will succeed since the supplied version of 2 is higher than the current document version of 1.\nIf the document was already updated and its version was set to 2 or higher, the indexing command will fail and result in a conflict (409 HTTP status code).\n\nA nice side effect is that there is no need to maintain strict ordering of async indexing operations run as a result of changes to a source database, as long as version numbers from the source database are used.\nEven the simple case of updating the Elasticsearch index using data from a database is simplified if external versioning is used, as only the latest version will be used if the index operations arrive out of order.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html" + "url": "https://www.elastic.co/docs/manage-data/data-store/data-streams" }, "operationId": "index-1", "parameters": [ @@ -4882,7 +4882,7 @@ "summary": "Create or update a script or search template", "description": "Creates or updates a stored script or search template.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + "url": "https://www.elastic.co/docs/solutions/search/search-templates" }, "operationId": "put-script", "parameters": [ @@ -4915,7 +4915,7 @@ "summary": "Create or update a script or search template", "description": "Creates or updates a stored script or search template.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + "url": "https://www.elastic.co/docs/solutions/search/search-templates" }, "operationId": "put-script-1", "parameters": [ @@ -5381,7 +5381,7 @@ "summary": "Get EQL search results", "description": "Returns search results for an Event Query Language (EQL) query.\nEQL assumes each document in a data stream or index corresponds to an event.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql.html" + "url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/eql" }, "operationId": "eql-search", "parameters": [ @@ -5430,7 +5430,7 @@ "summary": "Get EQL search results", "description": "Returns search results for an Event Query Language (EQL) query.\nEQL assumes each document in a data stream or index corresponds to an event.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql.html" + "url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/eql" }, "operationId": "eql-search-1", "parameters": [ @@ -5481,7 +5481,7 @@ "summary": "Run an ES|QL query", "description": "Get search results for an ES|QL (Elasticsearch query language) query.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/esql.html" + "url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/esql" }, "operationId": "esql-query", "parameters": [ @@ -5608,7 +5608,7 @@ "summary": "Get a document's source", "description": "Get the source of a document.\nFor example:\n\n```\nGET my-index-000001/_source/1\n```\n\nYou can use the source filtering parameters to control which parts of the `_source` are returned:\n\n```\nGET my-index-000001/_source/1/?_source_includes=*.id&_source_excludes=entities\n```", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-source-field.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-source-field" }, "operationId": "get-source", "parameters": [ @@ -5755,7 +5755,7 @@ "summary": "Check for a document source", "description": "Check whether a document source exists in an index.\nFor example:\n\n```\nHEAD my-index-000001/_source/1\n```\n\nA document's source is not available if it is disabled in the mapping.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-source-field.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-source-field" }, "operationId": "exists-source", "parameters": [ @@ -6195,7 +6195,7 @@ "summary": "Explore graph analytics", "description": "Extract and summarize information about the documents and terms in an Elasticsearch data stream or index.\nThe easiest way to understand the behavior of this API is to use the Graph UI to explore connections.\nAn initial request to the `_explore` API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph.\nSubsequent requests enable you to spider out from one more vertices of interest.\nYou can exclude vertices that have already been returned.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/kibana/current/xpack-graph.html" + "url": "https://www.elastic.co/docs/explore-analyze/visualize/graph" }, "operationId": "graph-explore", "parameters": [ @@ -6225,7 +6225,7 @@ "summary": "Explore graph analytics", "description": "Extract and summarize information about the documents and terms in an Elasticsearch data stream or index.\nThe easiest way to understand the behavior of this API is to use the Graph UI to explore connections.\nAn initial request to the `_explore` API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph.\nSubsequent requests enable you to spider out from one more vertices of interest.\nYou can exclude vertices that have already been returned.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/kibana/current/xpack-graph.html" + "url": "https://www.elastic.co/docs/explore-analyze/visualize/graph" }, "operationId": "graph-explore-1", "parameters": [ @@ -6257,7 +6257,7 @@ "summary": "Create or update a document in an index", "description": "Add a JSON document to the specified data stream or index and make it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.\n\nNOTE: You cannot use this API to send update requests for existing documents in a data stream.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:\n\n* To add or overwrite a document using the `PUT //_doc/<_id>` request format, you must have the `create`, `index`, or `write` index privilege.\n* To add a document using the `POST //_doc/` request format, you must have the `create_doc`, `create`, `index`, or `write` index privilege.\n* To automatically create a data stream or index with this API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege.\n\nAutomatic data stream creation requires a matching index template with data stream enabled.\n\nNOTE: Replica shards might not all be started when an indexing operation returns successfully.\nBy default, only the primary is required. Set `wait_for_active_shards` to change this default behavior.\n\n**Automatically create data streams and indices**\n\nIf the request's target doesn't exist and matches an index template with a `data_stream` definition, the index operation automatically creates the data stream.\n\nIf the target doesn't exist and doesn't match a data stream template, the operation automatically creates the index and applies any matching index templates.\n\nNOTE: Elasticsearch includes several built-in index templates. To avoid naming collisions with these templates, refer to index pattern documentation.\n\nIf no mapping exists, the index operation creates a dynamic mapping.\nBy default, new fields and objects are automatically added to the mapping if needed.\n\nAutomatic index creation is controlled by the `action.auto_create_index` setting.\nIf it is `true`, any index can be created automatically.\nYou can modify this setting to explicitly allow or block automatic creation of indices that match specified patterns or set it to `false` to turn off automatic index creation entirely.\nSpecify a comma-separated list of patterns you want to allow or prefix each pattern with `+` or `-` to indicate whether it should be allowed or blocked.\nWhen a list is specified, the default behaviour is to disallow.\n\nNOTE: The `action.auto_create_index` setting affects the automatic creation of indices only.\nIt does not affect the creation of data streams.\n\n**Optimistic concurrency control**\n\nIndex operations can be made conditional and only be performed if the last modification to the document was assigned the sequence number and primary term specified by the `if_seq_no` and `if_primary_term` parameters.\nIf a mismatch is detected, the operation will result in a `VersionConflictException` and a status code of `409`.\n\n**Routing**\n\nBy default, shard placement — or routing — is controlled by using a hash of the document's ID value.\nFor more explicit control, the value fed into the hash function used by the router can be directly specified on a per-operation basis using the `routing` parameter.\n\nWhen setting up explicit mapping, you can also use the `_routing` field to direct the index operation to extract the routing value from the document itself.\nThis does come at the (very minimal) cost of an additional document parsing pass.\nIf the `_routing` mapping is defined and set to be required, the index operation will fail if no routing value is provided or extracted.\n\nNOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template.\n\n**Distributed**\n\nThe index operation is directed to the primary shard based on its route and performed on the actual node containing this shard.\nAfter the primary shard completes the operation, if needed, the update is distributed to applicable replicas.\n\n**Active shards**\n\nTo improve the resiliency of writes to the system, indexing operations can be configured to wait for a certain number of active shard copies before proceeding with the operation.\nIf the requisite number of active shard copies are not available, then the write operation must wait and retry, until either the requisite shard copies have started or a timeout occurs.\nBy default, write operations only wait for the primary shards to be active before proceeding (that is to say `wait_for_active_shards` is `1`).\nThis default can be overridden in the index settings dynamically by setting `index.write.wait_for_active_shards`.\nTo alter this behavior per operation, use the `wait_for_active_shards request` parameter.\n\nValid values are all or any positive integer up to the total number of configured copies per shard in the index (which is `number_of_replicas`+1).\nSpecifying a negative value or a number greater than the number of shard copies will throw an error.\n\nFor example, suppose you have a cluster of three nodes, A, B, and C and you create an index index with the number of replicas set to 3 (resulting in 4 shard copies, one more copy than there are nodes).\nIf you attempt an indexing operation, by default the operation will only ensure the primary copy of each shard is available before proceeding.\nThis means that even if B and C went down and A hosted the primary shard copies, the indexing operation would still proceed with only one copy of the data.\nIf `wait_for_active_shards` is set on the request to `3` (and all three nodes are up), the indexing operation will require 3 active shard copies before proceeding.\nThis requirement should be met because there are 3 active nodes in the cluster, each one holding a copy of the shard.\nHowever, if you set `wait_for_active_shards` to `all` (or to `4`, which is the same in this situation), the indexing operation will not proceed as you do not have all 4 copies of each shard active in the index.\nThe operation will timeout unless a new node is brought up in the cluster to host the fourth copy of the shard.\n\nIt is important to note that this setting greatly reduces the chances of the write operation not writing to the requisite number of shard copies, but it does not completely eliminate the possibility, because this check occurs before the write operation starts.\nAfter the write operation is underway, it is still possible for replication to fail on any number of shard copies but still succeed on the primary.\nThe `_shards` section of the API response reveals the number of shard copies on which replication succeeded and failed.\n\n**No operation (noop) updates**\n\nWhen updating a document by using this API, a new version of the document is always created even if the document hasn't changed.\nIf this isn't acceptable use the `_update` API with `detect_noop` set to `true`.\nThe `detect_noop` option isn't available on this API because it doesn’t fetch the old source and isn't able to compare it against the new source.\n\nThere isn't a definitive rule for when noop updates aren't acceptable.\nIt's a combination of lots of factors like how frequently your data source sends updates that are actually noops and how many queries per second Elasticsearch runs on the shard receiving the updates.\n\n**Versioning**\n\nEach indexed document is given a version number.\nBy default, internal versioning is used that starts at 1 and increments with each update, deletes included.\nOptionally, the version number can be set to an external value (for example, if maintained in a database).\nTo enable this functionality, `version_type` should be set to `external`.\nThe value provided must be a numeric, long value greater than or equal to 0, and less than around `9.2e+18`.\n\nNOTE: Versioning is completely real time, and is not affected by the near real time aspects of search operations.\nIf no version is provided, the operation runs without any version checks.\n\nWhen using the external version type, the system checks to see if the version number passed to the index request is greater than the version of the currently stored document.\nIf true, the document will be indexed and the new version number used.\nIf the value provided is less than or equal to the stored document's version number, a version conflict will occur and the index operation will fail. For example:\n\n```\nPUT my-index-000001/_doc/1?version=2&version_type=external\n{\n \"user\": {\n \"id\": \"elkbee\"\n }\n}\n\nIn this example, the operation will succeed since the supplied version of 2 is higher than the current document version of 1.\nIf the document was already updated and its version was set to 2 or higher, the indexing command will fail and result in a conflict (409 HTTP status code).\n\nA nice side effect is that there is no need to maintain strict ordering of async indexing operations run as a result of changes to a source database, as long as version numbers from the source database are used.\nEven the simple case of updating the Elasticsearch index using data from a database is simplified if external versioning is used, as only the latest version will be used if the index operations arrive out of order.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html" + "url": "https://www.elastic.co/docs/manage-data/data-store/data-streams" }, "operationId": "index-2", "parameters": [ @@ -6441,7 +6441,7 @@ "summary": "Get tokens from text analysis", "description": "The analyze API performs analysis on a text string and returns the resulting tokens.\n\nGenerating excessive amount of tokens may cause a node to run out of memory.\nThe `index.analyze.max_token_count` setting enables you to limit the number of tokens that can be produced.\nIf more than this limit of tokens gets generated, an error occurs.\nThe `_analyze` endpoint without a specified index will always use `10000` as its limit.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html" + "url": "https://www.elastic.co/docs/manage-data/data-store/text-analysis" }, "operationId": "indices-analyze", "parameters": [ @@ -6465,7 +6465,7 @@ "summary": "Get tokens from text analysis", "description": "The analyze API performs analysis on a text string and returns the resulting tokens.\n\nGenerating excessive amount of tokens may cause a node to run out of memory.\nThe `index.analyze.max_token_count` setting enables you to limit the number of tokens that can be produced.\nIf more than this limit of tokens gets generated, an error occurs.\nThe `_analyze` endpoint without a specified index will always use `10000` as its limit.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html" + "url": "https://www.elastic.co/docs/manage-data/data-store/text-analysis" }, "operationId": "indices-analyze-1", "parameters": [ @@ -6491,7 +6491,7 @@ "summary": "Get tokens from text analysis", "description": "The analyze API performs analysis on a text string and returns the resulting tokens.\n\nGenerating excessive amount of tokens may cause a node to run out of memory.\nThe `index.analyze.max_token_count` setting enables you to limit the number of tokens that can be produced.\nIf more than this limit of tokens gets generated, an error occurs.\nThe `_analyze` endpoint without a specified index will always use `10000` as its limit.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html" + "url": "https://www.elastic.co/docs/manage-data/data-store/text-analysis" }, "operationId": "indices-analyze-2", "parameters": [ @@ -6518,7 +6518,7 @@ "summary": "Get tokens from text analysis", "description": "The analyze API performs analysis on a text string and returns the resulting tokens.\n\nGenerating excessive amount of tokens may cause a node to run out of memory.\nThe `index.analyze.max_token_count` setting enables you to limit the number of tokens that can be produced.\nIf more than this limit of tokens gets generated, an error occurs.\nThe `_analyze` endpoint without a specified index will always use `10000` as its limit.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html" + "url": "https://www.elastic.co/docs/manage-data/data-store/text-analysis" }, "operationId": "indices-analyze-3", "parameters": [ @@ -8062,7 +8062,7 @@ "summary": "Update field mappings", "description": "Add new fields to an existing data stream or index.\nYou can also use this API to change the search settings of existing fields and add new properties to existing object fields.\nFor data streams, these changes are applied to all backing indices by default.\n\n**Add multi-fields to an existing field**\n\nMulti-fields let you index the same field in different ways.\nYou can use this API to update the fields mapping parameter and enable multi-fields for an existing field.\nWARNING: If an index (or data stream) contains documents when you add a multi-field, those documents will not have values for the new multi-field.\nYou can populate the new multi-field with the update by query API.\n\n**Change supported mapping parameters for an existing field**\n\nThe documentation for each mapping parameter indicates whether you can update it for an existing field using this API.\nFor example, you can use the update mapping API to update the `ignore_above` parameter.\n\n**Change the mapping of an existing field**\n\nExcept for supported mapping parameters, you can't change the mapping or field type of an existing field.\nChanging an existing field could invalidate data that's already indexed.\n\nIf you need to change the mapping of a field in a data stream's backing indices, refer to documentation about modifying data streams.\nIf you need to change the mapping of a field in other indices, create a new index with the correct mapping and reindex your data into that index.\n\n**Rename a field**\n\nRenaming a field would invalidate data already indexed under the old field name.\nInstead, add an alias field to create an alternate field name.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-params.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-parameters" }, "operationId": "indices-put-mapping", "parameters": [ @@ -8104,7 +8104,7 @@ "summary": "Update field mappings", "description": "Add new fields to an existing data stream or index.\nYou can also use this API to change the search settings of existing fields and add new properties to existing object fields.\nFor data streams, these changes are applied to all backing indices by default.\n\n**Add multi-fields to an existing field**\n\nMulti-fields let you index the same field in different ways.\nYou can use this API to update the fields mapping parameter and enable multi-fields for an existing field.\nWARNING: If an index (or data stream) contains documents when you add a multi-field, those documents will not have values for the new multi-field.\nYou can populate the new multi-field with the update by query API.\n\n**Change supported mapping parameters for an existing field**\n\nThe documentation for each mapping parameter indicates whether you can update it for an existing field using this API.\nFor example, you can use the update mapping API to update the `ignore_above` parameter.\n\n**Change the mapping of an existing field**\n\nExcept for supported mapping parameters, you can't change the mapping or field type of an existing field.\nChanging an existing field could invalidate data that's already indexed.\n\nIf you need to change the mapping of a field in a data stream's backing indices, refer to documentation about modifying data streams.\nIf you need to change the mapping of a field in other indices, create a new index with the correct mapping and reindex your data into that index.\n\n**Rename a field**\n\nRenaming a field would invalidate data already indexed under the old field name.\nInstead, add an alias field to create an alternate field name.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-params.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-parameters" }, "operationId": "indices-put-mapping-1", "parameters": [ @@ -8184,7 +8184,7 @@ "summary": "Update index settings", "description": "Changes dynamic index settings in real time.\nFor data streams, index setting changes are applied to all backing indices by default.\n\nTo revert a setting to the default value, use a null value.\nThe list of per-index settings that can be updated dynamically on live indices can be found in index module documentation.\nTo preserve existing settings from being updated, set the `preserve_existing` parameter to `true`.\n\nNOTE: You can only define new analyzers on closed indices.\nTo add an analyzer, you must close the index, define the analyzer, and reopen the index.\nYou cannot close the write index of a data stream.\nTo update the analyzer for a data stream's write index and future backing indices, update the analyzer in the index template used by the stream.\nThen roll over the data stream to apply the new analyzer to the stream's write index and future backing indices.\nThis affects searches and any new data added to the stream after the rollover.\nHowever, it does not affect the data stream's backing indices or their existing data.\nTo change the analyzer for existing backing indices, you must create a new data stream and reindex your data into it.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/index-settings/index-modules" }, "operationId": "indices-put-settings", "parameters": [ @@ -8270,7 +8270,7 @@ "summary": "Update index settings", "description": "Changes dynamic index settings in real time.\nFor data streams, index setting changes are applied to all backing indices by default.\n\nTo revert a setting to the default value, use a null value.\nThe list of per-index settings that can be updated dynamically on live indices can be found in index module documentation.\nTo preserve existing settings from being updated, set the `preserve_existing` parameter to `true`.\n\nNOTE: You can only define new analyzers on closed indices.\nTo add an analyzer, you must close the index, define the analyzer, and reopen the index.\nYou cannot close the write index of a data stream.\nTo update the analyzer for a data stream's write index and future backing indices, update the analyzer in the index template used by the stream.\nThen roll over the data stream to apply the new analyzer to the stream's write index and future backing indices.\nThis affects searches and any new data added to the stream after the rollover.\nHowever, it does not affect the data stream's backing indices or their existing data.\nTo change the analyzer for existing backing indices, you must create a new data stream and reindex your data into it.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/index-settings/index-modules" }, "operationId": "indices-put-settings-1", "parameters": [ @@ -11264,7 +11264,7 @@ "summary": "Get pipelines", "description": "Get information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html" + "url": "https://www.elastic.co/docs/manage-data/ingest/transform-enrich/ingest-pipelines" }, "operationId": "ingest-get-pipeline-1", "parameters": [ @@ -11292,7 +11292,7 @@ "summary": "Create or update a pipeline", "description": "Changes made using this API take effect immediately.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html" + "url": "https://www.elastic.co/docs/manage-data/ingest/transform-enrich/ingest-pipelines" }, "operationId": "ingest-put-pipeline", "parameters": [ @@ -11410,7 +11410,7 @@ "summary": "Delete pipelines", "description": "Delete one or more ingest pipelines.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html" + "url": "https://www.elastic.co/docs/manage-data/ingest/transform-enrich/ingest-pipelines" }, "operationId": "ingest-delete-pipeline", "parameters": [ @@ -11469,7 +11469,7 @@ "summary": "Get pipelines", "description": "Get information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html" + "url": "https://www.elastic.co/docs/manage-data/ingest/transform-enrich/ingest-pipelines" }, "operationId": "ingest-get-pipeline", "parameters": [ @@ -11496,7 +11496,7 @@ "summary": "Run a grok processor", "description": "Extract structured fields out of a single text field within a document.\nYou must choose which field to extract matched fields from, as well as the grok pattern you expect will match.\nA grok pattern is like a regular expression that supports aliased expressions that can be reused.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/grok-processor.html" + "url": "https://www.elastic.co/docs/reference/enrich-processor/grok-processor" }, "operationId": "ingest-processor-grok", "responses": { @@ -11689,7 +11689,7 @@ "summary": "Get Logstash pipelines", "description": "Get pipelines that are used for Logstash Central Management.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html" + "url": "https://www.elastic.co/docs/reference/logstash/logstash-centralized-pipeline-management" }, "operationId": "logstash-get-pipeline-1", "parameters": [ @@ -11711,7 +11711,7 @@ "summary": "Create or update a Logstash pipeline", "description": "Create a pipeline that is used for Logstash Central Management.\nIf the specified pipeline exists, it is replaced.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html" + "url": "https://www.elastic.co/docs/reference/logstash/logstash-centralized-pipeline-management" }, "operationId": "logstash-put-pipeline", "parameters": [ @@ -11761,7 +11761,7 @@ "summary": "Delete a Logstash pipeline", "description": "Delete a pipeline that is used for Logstash Central Management.\nIf the request succeeds, you receive an empty response with an appropriate status code.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html" + "url": "https://www.elastic.co/docs/reference/logstash/logstash-centralized-pipeline-management" }, "operationId": "logstash-delete-pipeline", "parameters": [ @@ -11796,7 +11796,7 @@ "summary": "Get Logstash pipelines", "description": "Get pipelines that are used for Logstash Central Management.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html" + "url": "https://www.elastic.co/docs/reference/logstash/logstash-centralized-pipeline-management" }, "operationId": "logstash-get-pipeline", "responses": { @@ -16705,7 +16705,7 @@ "summary": "Run multiple templated searches", "description": "Run multiple templated searches with a single request.\nIf you are providing a text file or text input to `curl`, use the `--data-binary` flag instead of `-d` to preserve newlines.\nFor example:\n\n```\n$ cat requests\n{ \"index\": \"my-index\" }\n{ \"id\": \"my-search-template\", \"params\": { \"query_string\": \"hello world\", \"from\": 0, \"size\": 10 }}\n{ \"index\": \"my-other-index\" }\n{ \"id\": \"my-other-search-template\", \"params\": { \"query_type\": \"match_all\" }}\n\n$ curl -H \"Content-Type: application/x-ndjson\" -XGET localhost:9200/_msearch/template --data-binary \"@requests\"; echo\n```", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + "url": "https://www.elastic.co/docs/solutions/search/search-templates" }, "operationId": "msearch-template", "parameters": [ @@ -16742,7 +16742,7 @@ "summary": "Run multiple templated searches", "description": "Run multiple templated searches with a single request.\nIf you are providing a text file or text input to `curl`, use the `--data-binary` flag instead of `-d` to preserve newlines.\nFor example:\n\n```\n$ cat requests\n{ \"index\": \"my-index\" }\n{ \"id\": \"my-search-template\", \"params\": { \"query_string\": \"hello world\", \"from\": 0, \"size\": 10 }}\n{ \"index\": \"my-other-index\" }\n{ \"id\": \"my-other-search-template\", \"params\": { \"query_type\": \"match_all\" }}\n\n$ curl -H \"Content-Type: application/x-ndjson\" -XGET localhost:9200/_msearch/template --data-binary \"@requests\"; echo\n```", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + "url": "https://www.elastic.co/docs/solutions/search/search-templates" }, "operationId": "msearch-template-1", "parameters": [ @@ -16781,7 +16781,7 @@ "summary": "Run multiple templated searches", "description": "Run multiple templated searches with a single request.\nIf you are providing a text file or text input to `curl`, use the `--data-binary` flag instead of `-d` to preserve newlines.\nFor example:\n\n```\n$ cat requests\n{ \"index\": \"my-index\" }\n{ \"id\": \"my-search-template\", \"params\": { \"query_string\": \"hello world\", \"from\": 0, \"size\": 10 }}\n{ \"index\": \"my-other-index\" }\n{ \"id\": \"my-other-search-template\", \"params\": { \"query_type\": \"match_all\" }}\n\n$ curl -H \"Content-Type: application/x-ndjson\" -XGET localhost:9200/_msearch/template --data-binary \"@requests\"; echo\n```", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + "url": "https://www.elastic.co/docs/solutions/search/search-templates" }, "operationId": "msearch-template-2", "parameters": [ @@ -16821,7 +16821,7 @@ "summary": "Run multiple templated searches", "description": "Run multiple templated searches with a single request.\nIf you are providing a text file or text input to `curl`, use the `--data-binary` flag instead of `-d` to preserve newlines.\nFor example:\n\n```\n$ cat requests\n{ \"index\": \"my-index\" }\n{ \"id\": \"my-search-template\", \"params\": { \"query_string\": \"hello world\", \"from\": 0, \"size\": 10 }}\n{ \"index\": \"my-other-index\" }\n{ \"id\": \"my-other-search-template\", \"params\": { \"query_type\": \"match_all\" }}\n\n$ curl -H \"Content-Type: application/x-ndjson\" -XGET localhost:9200/_msearch/template --data-binary \"@requests\"; echo\n```", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + "url": "https://www.elastic.co/docs/solutions/search/search-templates" }, "operationId": "msearch-template-3", "parameters": [ @@ -17228,7 +17228,7 @@ "summary": "Create or update a script or search template", "description": "Creates or updates a stored script or search template.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + "url": "https://www.elastic.co/docs/solutions/search/search-templates" }, "operationId": "put-script-2", "parameters": [ @@ -17264,7 +17264,7 @@ "summary": "Create or update a script or search template", "description": "Creates or updates a stored script or search template.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + "url": "https://www.elastic.co/docs/solutions/search/search-templates" }, "operationId": "put-script-3", "parameters": [ @@ -17302,7 +17302,7 @@ "summary": "Get a query rule", "description": "Get details about a query rule within a query ruleset.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-using-query-rules.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/searching-with-query-rules" }, "operationId": "query-rules-get-rule", "parameters": [ @@ -17542,7 +17542,7 @@ "summary": "Create or update a query ruleset", "description": "There is a limit of 100 rules per ruleset.\nThis limit can be increased by using the `xpack.applications.rules.max_rules_per_ruleset` cluster setting.\n\nIMPORTANT: Due to limitations within pinned queries, you can only select documents using `ids` or `docs`, but cannot use both in single rule.\nIt is advised to use one or the other in query rulesets, to avoid errors.\nAdditionally, pinned queries have a maximum limit of 100 pinned hits.\nIf multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-using-query-rules.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/searching-with-query-rules" }, "operationId": "query-rules-put-ruleset", "parameters": [ @@ -18326,7 +18326,7 @@ "summary": "Run a search", "description": "Get search hits that match the query defined in the request.\nYou can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.\n\nIf the Elasticsearch security features are enabled, you must have the read index privilege for the target data stream, index, or alias. For cross-cluster search, refer to the documentation about configuring CCS privileges.\nTo search a point in time (PIT) for an alias, you must have the `read` index privilege for the alias's data streams or indices.\n\n**Search slicing**\n\nWhen paging through a large number of documents, it can be helpful to split the search into multiple slices to consume them independently with the `slice` and `pit` properties.\nBy default the splitting is done first on the shards, then locally on each shard.\nThe local splitting partitions the shard into contiguous ranges based on Lucene document IDs.\n\nFor instance if the number of shards is equal to 2 and you request 4 slices, the slices 0 and 2 are assigned to the first shard and the slices 1 and 3 are assigned to the second shard.\n\nIMPORTANT: The same point-in-time ID should be used for all slices.\nIf different PIT IDs are used, slices can overlap and miss documents.\nThis situation can occur because the splitting criterion is based on Lucene document IDs, which are not stable across changes to the index.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/remote-clusters-cert.html#remote-clusters-privileges-ccs" + "url": "https://www.elastic.co/docs/deploy-manage/remote-clusters/remote-clusters-cert#remote-clusters-privileges-ccs" }, "operationId": "search", "parameters": [ @@ -18476,7 +18476,7 @@ "summary": "Run a search", "description": "Get search hits that match the query defined in the request.\nYou can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.\n\nIf the Elasticsearch security features are enabled, you must have the read index privilege for the target data stream, index, or alias. For cross-cluster search, refer to the documentation about configuring CCS privileges.\nTo search a point in time (PIT) for an alias, you must have the `read` index privilege for the alias's data streams or indices.\n\n**Search slicing**\n\nWhen paging through a large number of documents, it can be helpful to split the search into multiple slices to consume them independently with the `slice` and `pit` properties.\nBy default the splitting is done first on the shards, then locally on each shard.\nThe local splitting partitions the shard into contiguous ranges based on Lucene document IDs.\n\nFor instance if the number of shards is equal to 2 and you request 4 slices, the slices 0 and 2 are assigned to the first shard and the slices 1 and 3 are assigned to the second shard.\n\nIMPORTANT: The same point-in-time ID should be used for all slices.\nIf different PIT IDs are used, slices can overlap and miss documents.\nThis situation can occur because the splitting criterion is based on Lucene document IDs, which are not stable across changes to the index.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/remote-clusters-cert.html#remote-clusters-privileges-ccs" + "url": "https://www.elastic.co/docs/deploy-manage/remote-clusters/remote-clusters-cert#remote-clusters-privileges-ccs" }, "operationId": "search-1", "parameters": [ @@ -18628,7 +18628,7 @@ "summary": "Run a search", "description": "Get search hits that match the query defined in the request.\nYou can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.\n\nIf the Elasticsearch security features are enabled, you must have the read index privilege for the target data stream, index, or alias. For cross-cluster search, refer to the documentation about configuring CCS privileges.\nTo search a point in time (PIT) for an alias, you must have the `read` index privilege for the alias's data streams or indices.\n\n**Search slicing**\n\nWhen paging through a large number of documents, it can be helpful to split the search into multiple slices to consume them independently with the `slice` and `pit` properties.\nBy default the splitting is done first on the shards, then locally on each shard.\nThe local splitting partitions the shard into contiguous ranges based on Lucene document IDs.\n\nFor instance if the number of shards is equal to 2 and you request 4 slices, the slices 0 and 2 are assigned to the first shard and the slices 1 and 3 are assigned to the second shard.\n\nIMPORTANT: The same point-in-time ID should be used for all slices.\nIf different PIT IDs are used, slices can overlap and miss documents.\nThis situation can occur because the splitting criterion is based on Lucene document IDs, which are not stable across changes to the index.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/remote-clusters-cert.html#remote-clusters-privileges-ccs" + "url": "https://www.elastic.co/docs/deploy-manage/remote-clusters/remote-clusters-cert#remote-clusters-privileges-ccs" }, "operationId": "search-2", "parameters": [ @@ -18781,7 +18781,7 @@ "summary": "Run a search", "description": "Get search hits that match the query defined in the request.\nYou can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.\n\nIf the Elasticsearch security features are enabled, you must have the read index privilege for the target data stream, index, or alias. For cross-cluster search, refer to the documentation about configuring CCS privileges.\nTo search a point in time (PIT) for an alias, you must have the `read` index privilege for the alias's data streams or indices.\n\n**Search slicing**\n\nWhen paging through a large number of documents, it can be helpful to split the search into multiple slices to consume them independently with the `slice` and `pit` properties.\nBy default the splitting is done first on the shards, then locally on each shard.\nThe local splitting partitions the shard into contiguous ranges based on Lucene document IDs.\n\nFor instance if the number of shards is equal to 2 and you request 4 slices, the slices 0 and 2 are assigned to the first shard and the slices 1 and 3 are assigned to the second shard.\n\nIMPORTANT: The same point-in-time ID should be used for all slices.\nIf different PIT IDs are used, slices can overlap and miss documents.\nThis situation can occur because the splitting criterion is based on Lucene document IDs, which are not stable across changes to the index.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/remote-clusters-cert.html#remote-clusters-privileges-ccs" + "url": "https://www.elastic.co/docs/deploy-manage/remote-clusters/remote-clusters-cert#remote-clusters-privileges-ccs" }, "operationId": "search-3", "parameters": [ @@ -19429,7 +19429,7 @@ ], "summary": "Run a search with a search template", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + "url": "https://www.elastic.co/docs/solutions/search/search-templates" }, "operationId": "search-template", "parameters": [ @@ -19489,7 +19489,7 @@ ], "summary": "Run a search with a search template", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + "url": "https://www.elastic.co/docs/solutions/search/search-templates" }, "operationId": "search-template-1", "parameters": [ @@ -19551,7 +19551,7 @@ ], "summary": "Run a search with a search template", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + "url": "https://www.elastic.co/docs/solutions/search/search-templates" }, "operationId": "search-template-2", "parameters": [ @@ -19614,7 +19614,7 @@ ], "summary": "Run a search with a search template", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html" + "url": "https://www.elastic.co/docs/solutions/search/search-templates" }, "operationId": "search-template-3", "parameters": [ @@ -19898,7 +19898,7 @@ "summary": "Create an API key", "description": "Create an API key for access without requiring basic authentication.\n\nIMPORTANT: If the credential that is used to authenticate this request is an API key, the derived API key cannot have any privileges.\nIf you specify privileges, the API returns an error.\n\nA successful request returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\n\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.\n\nThe API keys are created by the Elasticsearch API key service, which is automatically enabled.\nTo configure or turn off the API key service, refer to API key service setting documentation.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-settings.html#api-key-service-settings" + "url": "https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/security-settings#api-key-service-settings" }, "operationId": "security-create-api-key", "parameters": [ @@ -19923,7 +19923,7 @@ "summary": "Create an API key", "description": "Create an API key for access without requiring basic authentication.\n\nIMPORTANT: If the credential that is used to authenticate this request is an API key, the derived API key cannot have any privileges.\nIf you specify privileges, the API returns an error.\n\nA successful request returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\n\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.\n\nThe API keys are created by the Elasticsearch API key service, which is automatically enabled.\nTo configure or turn off the API key service, refer to API key service setting documentation.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-settings.html#api-key-service-settings" + "url": "https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/security-settings#api-key-service-settings" }, "operationId": "security-create-api-key-1", "parameters": [ @@ -20095,7 +20095,7 @@ "summary": "Create or update roles", "description": "The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management.\nThe create or update roles API cannot update roles that are defined in roles files.\nFile-based role management is not available in Elastic Serverless.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/defining-roles.html" + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/defining-roles" }, "operationId": "security-put-role", "parameters": [ @@ -20122,7 +20122,7 @@ "summary": "Create or update roles", "description": "The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management.\nThe create or update roles API cannot update roles that are defined in roles files.\nFile-based role management is not available in Elastic Serverless.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/defining-roles.html" + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/defining-roles" }, "operationId": "security-put-role-1", "parameters": [ @@ -20209,7 +20209,7 @@ "summary": "Get builtin privileges", "description": "Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/security-privileges" }, "operationId": "security-get-builtin-privileges", "responses": { @@ -20276,7 +20276,7 @@ "summary": "Check user privileges", "description": "Determine whether the specified user has a specified list of privileges.\nAll users can use this API, but only to determine their own privileges.\nTo check the privileges of other users, you must use the run as feature.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/security-privileges" }, "operationId": "security-has-privileges", "requestBody": { @@ -20296,7 +20296,7 @@ "summary": "Check user privileges", "description": "Determine whether the specified user has a specified list of privileges.\nAll users can use this API, but only to determine their own privileges.\nTo check the privileges of other users, you must use the run as feature.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/security-privileges" }, "operationId": "security-has-privileges-1", "requestBody": { @@ -20318,7 +20318,7 @@ "summary": "Check user privileges", "description": "Determine whether the specified user has a specified list of privileges.\nAll users can use this API, but only to determine their own privileges.\nTo check the privileges of other users, you must use the run as feature.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/security-privileges" }, "operationId": "security-has-privileges-2", "parameters": [ @@ -20343,7 +20343,7 @@ "summary": "Check user privileges", "description": "Determine whether the specified user has a specified list of privileges.\nAll users can use this API, but only to determine their own privileges.\nTo check the privileges of other users, you must use the run as feature.", "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/security-privileges" }, "operationId": "security-has-privileges-3", "parameters": [ @@ -23436,7 +23436,7 @@ }, "_types.aggregations.Aggregate": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations.html" + "url": "https://www.elastic.co/docs/explore-analyze/query-filter/aggregations" }, "oneOf": [ { @@ -28793,7 +28793,7 @@ }, "_types.query_dsl.QueryContainer": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html" + "url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl" }, "description": "An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.", "type": "object", @@ -28833,7 +28833,7 @@ }, "fuzzy": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-fuzzy-query.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-fuzzy-query" }, "description": "Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance.", "type": "object", @@ -28875,7 +28875,7 @@ }, "intervals": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-intervals-query.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-intervals-query" }, "description": "Returns documents based on the order and proximity of matching terms.", "type": "object", @@ -28890,7 +28890,7 @@ }, "match": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query" }, "description": "Returns documents that match a provided text, number, date or boolean value.\nThe provided text is analyzed before matching.", "type": "object", @@ -28905,7 +28905,7 @@ }, "match_bool_prefix": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-bool-prefix-query.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-bool-prefix-query" }, "description": "Analyzes its input and constructs a `bool` query from the terms.\nEach term except the last is used in a `term` query.\nThe last term is used in a prefix query.", "type": "object", @@ -28920,7 +28920,7 @@ }, "match_phrase": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query-phrase.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query-phrase" }, "description": "Analyzes the text and creates a phrase query out of the analyzed text.", "type": "object", @@ -28932,7 +28932,7 @@ }, "match_phrase_prefix": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query-phrase-prefix.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query-phrase-prefix" }, "description": "Returns documents that contain the words of a provided text, in the same order as provided.\nThe last term of the provided text is treated as a prefix, matching any words that begin with that term.", "type": "object", @@ -28962,7 +28962,7 @@ }, "prefix": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-prefix-query.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-prefix-query" }, "description": "Returns documents that contain a specific prefix in a provided field.", "type": "object", @@ -28977,7 +28977,7 @@ }, "range": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-range-query" }, "description": "Returns documents that contain terms within a provided range.", "type": "object", @@ -28992,7 +28992,7 @@ }, "regexp": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-regexp-query.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-regexp-query" }, "description": "Returns documents that contain terms matching a regular expression.", "type": "object", @@ -29043,7 +29043,7 @@ }, "span_term": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-term-query.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-term-query" }, "description": "Matches spans containing a term.", "type": "object", @@ -29061,7 +29061,7 @@ }, "term": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-term-query.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-term-query" }, "description": "Returns documents that contain an exact term in a provided field.\nTo return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.", "type": "object", @@ -29076,7 +29076,7 @@ }, "terms_set": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-set-query.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-terms-set-query" }, "description": "Returns documents that contain a minimum number of exact terms in a provided field.\nTo return a document, a required number of terms must exactly match the field values, including whitespace and capitalization.", "type": "object", @@ -29089,7 +29089,7 @@ "text_expansion": { "deprecated": true, "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-text-expansion-query.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-text-expansion-query" }, "description": "Uses a natural language processing model to convert the query text into a list of token-weight pairs which are then used in a query against a sparse vector or rank features field.", "type": "object", @@ -29102,7 +29102,7 @@ "weighted_tokens": { "deprecated": true, "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-weighted-tokens-query.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-weighted-tokens-query" }, "description": "Supports returning text_expansion query results by sending in precomputed tokens with the query.", "type": "object", @@ -29114,7 +29114,7 @@ }, "wildcard": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-wildcard-query.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-wildcard-query" }, "description": "Returns documents that contain terms matching a wildcard pattern.", "type": "object", @@ -29388,7 +29388,7 @@ }, "_types.query_dsl.DistanceFeatureQuery": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-distance-feature-query.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-distance-feature-query" }, "oneOf": [ { @@ -29859,7 +29859,7 @@ }, "indices_boost": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html#relevance-scores" + "url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl#relevance-scores" }, "description": "Boost the `_score` of documents from specified indices.\nThe boost value is the factor by which scores are multiplied.\nA boost value greater than `1.0` increases the score.\nA boost value between `0` and `1.0` decreases the score.", "type": "array", @@ -29874,7 +29874,7 @@ }, "docvalue_fields": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-fields.html#docvalue-fields" + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#docvalue-fields" }, "description": "An array of wildcard (`*`) field patterns.\nThe request returns doc values for field names matching these patterns in the `hits.fields` property of the response.", "type": "array", @@ -29884,7 +29884,7 @@ }, "knn": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/knn-search.html#approximate-knn" + "url": "https://www.elastic.co/docs/solutions/search/vector/knn#approximate-knn" }, "description": "The approximate kNN search to run.", "oneOf": [ @@ -29981,7 +29981,7 @@ }, "seq_no_primary_term": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/optimistic-concurrency-control.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control" }, "description": "If `true`, the request returns sequence number and primary term of the last modification of each hit.", "type": "boolean" @@ -31340,7 +31340,7 @@ }, { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-intervals-query.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-intervals-query" }, "type": "object", "properties": { @@ -31842,7 +31842,7 @@ "properties": { "analyzer": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html" + "url": "https://www.elastic.co/docs/manage-data/data-store/text-analysis" }, "description": "The analyzer that is used to analyze the free form text.\nDefaults to the analyzer associated with the first field in fields.", "type": "string" @@ -32208,7 +32208,7 @@ }, { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-pinned-query.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-pinned-query" }, "allOf": [ { @@ -32401,7 +32401,7 @@ }, "_types.query_dsl.RangeQuery": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-range-query" }, "oneOf": [ { @@ -33324,7 +33324,7 @@ }, { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-sparse-vector-query.html" + "url": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-sparse-vector-query" }, "allOf": [ { @@ -40852,7 +40852,7 @@ }, "_types.analysis.CharFilter": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-charfilters.html" + "url": "https://www.elastic.co/docs/reference/text-analysis/character-filter-reference" }, "oneOf": [ { @@ -41039,7 +41039,7 @@ }, "_types.analysis.TokenFilter": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenfilters.html" + "url": "https://www.elastic.co/docs/reference/text-analysis/token-filter-reference" }, "oneOf": [ { @@ -42898,7 +42898,7 @@ }, "_types.analysis.Tokenizer": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenizers.html" + "url": "https://www.elastic.co/docs/reference/text-analysis/tokenizer-reference" }, "oneOf": [ { @@ -50507,7 +50507,7 @@ }, "model_id": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/machine-learning/current/ml-nlp-import-model.html#ml-nlp-import-script" + "url": "https://www.elastic.co/docs/explore-analyze/machine-learning/nlp/ml-nlp-import-model#ml-nlp-import-script" }, "description": "The name of the model to use for the inference task.\nIt can be the ID of a built-in model (for example, `.multilingual-e5-small` for E5) or a text embedding model that was uploaded by using the Eland client.", "type": "string" @@ -53281,7 +53281,7 @@ }, "pipeline": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/logstash/current/configuration-file-structure.html" + "url": "https://www.elastic.co/docs/reference/logstash/configuration-file-structure" }, "description": "The configuration for the pipeline.", "type": "string" @@ -59017,7 +59017,7 @@ }, "run_as": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/run-as-privilege.html" + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/submitting-requests-on-behalf-of-other-users" }, "description": "A list of users that the API keys can impersonate.\nNOTE: In Elastic Cloud Serverless, the run-as feature is disabled.\nFor API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected.", "type": "array", @@ -69387,7 +69387,7 @@ }, "indices_boost": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html#relevance-scores" + "url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl#relevance-scores" }, "description": "Boost the `_score` of documents from specified indices.\nThe boost value is the factor by which scores are multiplied.\nA boost value greater than `1.0` increases the score.\nA boost value between `0` and `1.0` decreases the score.", "type": "array", @@ -69402,7 +69402,7 @@ }, "docvalue_fields": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-fields.html#docvalue-fields" + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#docvalue-fields" }, "description": "An array of wildcard (`*`) field patterns.\nThe request returns doc values for field names matching these patterns in the `hits.fields` property of the response.", "type": "array", @@ -69412,7 +69412,7 @@ }, "knn": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/knn-search.html#approximate-knn" + "url": "https://www.elastic.co/docs/solutions/search/vector/knn#approximate-knn" }, "description": "The approximate kNN search to run.", "oneOf": [ @@ -69509,7 +69509,7 @@ }, "seq_no_primary_term": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/optimistic-concurrency-control.html" + "url": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control" }, "description": "If `true`, the request returns sequence number and primary term of the last modification of each hit.", "type": "boolean" @@ -69790,7 +69790,7 @@ }, "run_as": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/run-as-privilege.html" + "url": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/submitting-requests-on-behalf-of-other-users" }, "description": "A list of users that the owners of this role can impersonate. *Note*: in Serverless, the run-as feature is disabled. For API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected.", "type": "array", @@ -69940,7 +69940,7 @@ }, "columnar": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-rest-columnar.html" + "url": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/sql-rest-columnar" }, "description": "If `true`, the results are in a columnar fashion: one row represents all the values of a certain column from the current page of results.\nThe API supports this parameter only for CBOR, JSON, SMILE, and YAML responses.", "type": "boolean" @@ -69983,7 +69983,7 @@ }, "query": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-spec.html" + "url": "https://www.elastic.co/docs/reference/query-languages/sql/sql-spec" }, "description": "The SQL query to run.", "type": "string" diff --git a/output/schema/schema.json b/output/schema/schema.json index 11510d3f03..75295b733a 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -333,7 +333,7 @@ "docId": "autoscaling-delete-autoscaling-policy", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-delete-autoscaling-policy", "extDocId": "autoscaling", - "extDocUrl": "https://www.elastic.co/guide/en/cloud/current/ec-autoscaling.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/autoscaling", "name": "autoscaling.delete_autoscaling_policy", "request": { "name": "Request", @@ -367,7 +367,7 @@ "docId": "autoscaling-get-autoscaling-capacity", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-get-autoscaling-capacity", "extDocId": "autoscaling", - "extDocUrl": "https://www.elastic.co/guide/en/cloud/current/ec-autoscaling.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/autoscaling", "name": "autoscaling.get_autoscaling_capacity", "request": { "name": "Request", @@ -401,7 +401,7 @@ "docId": "autoscaling-get-autoscaling-capacity", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-get-autoscaling-capacity", "extDocId": "autoscaling", - "extDocUrl": "https://www.elastic.co/guide/en/cloud/current/ec-autoscaling.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/autoscaling", "name": "autoscaling.get_autoscaling_policy", "request": { "name": "Request", @@ -435,7 +435,7 @@ "docId": "autoscaling-put-autoscaling-policy", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-put-autoscaling-policy", "extDocId": "autoscaling", - "extDocUrl": "https://www.elastic.co/guide/en/cloud/current/ec-autoscaling.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/autoscaling", "name": "autoscaling.put_autoscaling_policy", "request": { "name": "Request", @@ -1728,7 +1728,7 @@ "docId": "ccr-delete-auto-follow-pattern", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-delete-auto-follow-pattern", "extDocId": "ccr-auto-follow", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-auto-follow.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/tools/cross-cluster-replication/manage-auto-follow-patterns", "name": "ccr.delete_auto_follow_pattern", "privileges": { "cluster": [ @@ -1802,7 +1802,7 @@ "docId": "ccr-get-follow-info", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-follow-info", "extDocId": "ccr", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-ccr.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/tools/cross-cluster-replication", "name": "ccr.follow_info", "privileges": { "cluster": [ @@ -1841,7 +1841,7 @@ "docId": "ccr-get-follow-stats", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-follow-stats", "extDocId": "ccr", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-ccr.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/tools/cross-cluster-replication", "name": "ccr.follow_stats", "privileges": { "cluster": [ @@ -1880,7 +1880,7 @@ "docId": "ccr-post-forget-follower", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-forget-follower", "extDocId": "ccr", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-ccr.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/tools/cross-cluster-replication", "name": "ccr.forget_follower", "request": { "name": "Request", @@ -1917,7 +1917,7 @@ "docId": "ccr-get-auto-follow-pattern", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-get-auto-follow-pattern-1", "extDocId": "ccr-auto-follow", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-auto-follow.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/tools/cross-cluster-replication/manage-auto-follow-patterns", "name": "ccr.get_auto_follow_pattern", "privileges": { "cluster": [ @@ -1962,7 +1962,7 @@ "docId": "ccr-pause-auto-follow-pattern", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-pause-auto-follow-pattern", "extDocId": "ccr-auto-follow", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-auto-follow.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/tools/cross-cluster-replication/manage-auto-follow-patterns", "name": "ccr.pause_auto_follow_pattern", "privileges": { "cluster": [ @@ -2038,7 +2038,7 @@ "docId": "ccr-put-auto-follow-pattern", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-put-auto-follow-pattern", "extDocId": "ccr-auto-follow", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-auto-follow.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/tools/cross-cluster-replication/manage-auto-follow-patterns", "name": "ccr.put_auto_follow_pattern", "request": { "name": "Request", @@ -2075,7 +2075,7 @@ "docId": "ccr-resume-auto-follow-pattern", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-resume-auto-follow-pattern", "extDocId": "ccr-auto-follow", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-auto-follow.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/tools/cross-cluster-replication/manage-auto-follow-patterns", "name": "ccr.resume_auto_follow_pattern", "privileges": { "cluster": [ @@ -2114,7 +2114,7 @@ "docId": "ccr-post-resume-follow", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-resume-follow", "extDocId": "ccr", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-ccr.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/tools/cross-cluster-replication", "name": "ccr.resume_follow", "request": { "name": "Request", @@ -2188,7 +2188,7 @@ "docId": "ccr-post-unfollow", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-unfollow", "extDocId": "ccr", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-ccr.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/tools/cross-cluster-replication", "name": "ccr.unfollow", "privileges": { "index": [ @@ -2231,7 +2231,7 @@ "docTag": "search", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-clear-scroll", "extDocId": "scroll-search-results", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#scroll-search-results", "name": "clear_scroll", "request": { "name": "Request", @@ -2402,7 +2402,7 @@ "docId": "voting-config-exclusions", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-post-voting-config-exclusions", "extDocId": "add-nodes", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/add-elasticsearch-nodes.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/maintenance/add-and-remove-elasticsearch-nodes", "name": "cluster.delete_voting_config_exclusions", "request": { "name": "Request", @@ -2686,7 +2686,7 @@ "docId": "voting-config-exclusions", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-post-voting-config-exclusions", "extDocId": "add-nodes", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/add-elasticsearch-nodes.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/maintenance/add-and-remove-elasticsearch-nodes", "name": "cluster.post_voting_config_exclusions", "request": { "name": "Request", @@ -2804,7 +2804,7 @@ "docId": "cluster-remote-info", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-remote-info", "extDocId": "modules-cross-cluster-search", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-cross-cluster-search.html", + "extDocUrl": "https://www.elastic.co/docs/solutions/search/cross-cluster-search", "name": "cluster.remote_info", "privileges": { "cluster": [ @@ -4270,7 +4270,7 @@ "docTag": "document", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-create", "extDocId": "data-streams", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html", + "extDocUrl": "https://www.elastic.co/docs/manage-data/data-store/data-streams", "name": "create", "privileges": { "index": [ @@ -4893,7 +4893,7 @@ "docId": "eql-search-api", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-search", "extDocId": "eql", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql.html", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/eql", "name": "eql.search", "request": { "name": "Request", @@ -4932,7 +4932,7 @@ "docId": "esql-async-query", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-async-query", "extDocId": "esql", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/esql.html", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/esql", "name": "esql.async_query", "privileges": { "index": [ @@ -4975,7 +4975,7 @@ "docId": "esql-async-query-delete", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-async-query-delete", "extDocId": "esql", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/esql.html", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/esql", "name": "esql.async_query_delete", "request": { "name": "Request", @@ -5010,7 +5010,7 @@ "docId": "esql-async-query-get", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-async-query-get", "extDocId": "esql", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/esql.html", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/esql", "name": "esql.async_query_get", "request": { "name": "Request", @@ -5045,7 +5045,7 @@ "docId": "esql-async-query-stop", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-async-query-stop-api.html", "extDocId": "esql", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/esql.html", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/esql", "name": "esql.async_query_stop", "request": { "name": "Request", @@ -5077,9 +5077,9 @@ }, "description": "Run an ES|QL query.\nGet search results for an ES|QL (Elasticsearch query language) query.", "docId": "esql-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-rest.html", + "docUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/esql-rest", "extDocId": "esql", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/esql.html", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/esql", "name": "esql.query", "request": { "name": "Request", @@ -5157,7 +5157,7 @@ "docTag": "document", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get", "extDocId": "mapping-source-field", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-source-field.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-source-field", "name": "exists_source", "privileges": { "index": [ @@ -5241,7 +5241,7 @@ "docId": "get-features-api", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-features-get-features", "extDocId": "snapshot-create", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-take-snapshot.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/create-snapshots", "name": "features.get_features", "request": { "name": "Request", @@ -5736,7 +5736,7 @@ "docTag": "document", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get", "extDocId": "mapping-source-field", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-source-field.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-source-field", "name": "get_source", "privileges": { "index": [ @@ -5778,7 +5778,7 @@ "docId": "graph-explore-api", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-graph", "extDocId": "graph", - "extDocUrl": "https://www.elastic.co/guide/en/kibana/current/xpack-graph.html", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/visualize/graph", "name": "graph.explore", "request": { "name": "Request", @@ -6014,7 +6014,7 @@ "docId": "ilm-migrate-to-data-tiers", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-migrate-to-data-tiers", "extDocId": "migrate-index-allocation-filters", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/migrate-index-allocation-filters.html", + "extDocUrl": "https://www.elastic.co/docs/manage-data/lifecycle/index-lifecycle-management/migrate-index-allocation-filters-to-node-roles", "name": "ilm.migrate_to_data_tiers", "request": { "name": "Request", @@ -6091,7 +6091,7 @@ "docId": "ilm-put-lifecycle", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-put-lifecycle", "extDocId": "ilm-index-lifecycle", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-index-lifecycle.html", + "extDocUrl": "https://www.elastic.co/docs/manage-data/lifecycle/index-lifecycle-management/index-lifecycle", "name": "ilm.put_lifecycle", "privileges": { "cluster": [ @@ -6288,7 +6288,7 @@ "docTag": "document", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-create", "extDocId": "data-streams", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html", + "extDocUrl": "https://www.elastic.co/docs/manage-data/data-store/data-streams", "name": "index", "privileges": { "index": [ @@ -6376,7 +6376,7 @@ "docId": "indices-analyze", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-analyze", "extDocId": "analysis", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "extDocUrl": "https://www.elastic.co/docs/manage-data/data-store/text-analysis", "name": "indices.analyze", "privileges": { "index": [ @@ -7221,7 +7221,7 @@ "docId": "indices-template-exists-v1", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists-template", "extDocId": "index-templates", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index-templates.html", + "extDocUrl": "https://www.elastic.co/docs/manage-data/data-store/templates", "name": "indices.exists_template", "privileges": { "cluster": [ @@ -7390,7 +7390,7 @@ "docId": "indices-forcemerge", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-forcemerge", "extDocId": "index-modules-merge", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules-merge.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/index-settings/merge", "name": "indices.forcemerge", "privileges": { "index": [ @@ -7915,7 +7915,7 @@ "docId": "indices-get-template-v1", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-template", "extDocId": "index-templates", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index-templates.html", + "extDocUrl": "https://www.elastic.co/docs/manage-data/data-store/templates", "name": "indices.get_template", "privileges": { "cluster": [ @@ -8314,7 +8314,7 @@ "docId": "indices-put-mapping", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-mapping", "extDocId": "mapping-params", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-params.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-parameters", "name": "indices.put_mapping", "privileges": { "index": [ @@ -8360,7 +8360,7 @@ "docId": "indices-update-settings", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-settings", "extDocId": "index-modules", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/index-settings/index-modules", "name": "indices.put_settings", "privileges": { "index": [ @@ -8407,7 +8407,7 @@ "docId": "index-templates-v1", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-template", "extDocId": "index-templates", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index-templates.html", + "extDocUrl": "https://www.elastic.co/docs/manage-data/data-store/templates", "name": "indices.put_template", "privileges": { "cluster": [ @@ -8545,7 +8545,7 @@ "docId": "indices-reload-analyzers", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-reload-search-analyzers", "extDocId": "search-analyzer", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-analyzer.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/search-analyzer", "name": "indices.reload_search_analyzers", "privileges": { "index": [ @@ -10407,7 +10407,7 @@ "docId": "delete-pipeline-api", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-delete-pipeline", "extDocId": "ingest", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html", + "extDocUrl": "https://www.elastic.co/docs/manage-data/ingest/transform-enrich/ingest-pipelines", "name": "ingest.delete_pipeline", "request": { "name": "Request", @@ -10443,9 +10443,9 @@ }, "description": "Get GeoIP statistics.\nGet download statistics for GeoIP2 databases that are used with the GeoIP processor.", "docId": "geoip-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/geoip-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/geoip-processor", "extDocId": "geoip-processor", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/geoip-processor.html", + "extDocUrl": "https://www.elastic.co/docs/reference/enrich-processor/geoip-processor", "name": "ingest.geo_ip_stats", "request": { "name": "Request", @@ -10570,7 +10570,7 @@ "docId": "get-pipeline-api", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-get-pipeline", "extDocId": "ingest", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html", + "extDocUrl": "https://www.elastic.co/docs/manage-data/ingest/transform-enrich/ingest-pipelines", "name": "ingest.get_pipeline", "request": { "name": "Request", @@ -10612,9 +10612,9 @@ }, "description": "Run a grok processor.\nExtract structured fields out of a single text field within a document.\nYou must choose which field to extract matched fields from, as well as the grok pattern you expect will match.\nA grok pattern is like a regular expression that supports aliased expressions that can be reused.", "docId": "grok-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/grok-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/grok-processor", "extDocId": "grok-processor", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/grok-processor.html", + "extDocUrl": "https://www.elastic.co/docs/reference/enrich-processor/grok-processor", "name": "ingest.processor_grok", "request": { "name": "Request", @@ -10731,9 +10731,9 @@ }, "description": "Create or update a pipeline.\nChanges made using this API take effect immediately.", "docId": "ingest", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html", + "docUrl": "https://www.elastic.co/docs/manage-data/ingest/transform-enrich/ingest-pipelines", "extDocId": "ingest", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html", + "extDocUrl": "https://www.elastic.co/docs/manage-data/ingest/transform-enrich/ingest-pipelines", "name": "ingest.put_pipeline", "request": { "name": "Request", @@ -10825,7 +10825,7 @@ "description": "Run a knn search.\n\nNOTE: The kNN search API has been replaced by the `knn` option in the search API.\n\nPerform a k-nearest neighbor (kNN) search on a dense_vector field and return the matching documents.\nGiven a query vector, the API finds the k closest vectors and returns those documents as search hits.\n\nElasticsearch uses the HNSW algorithm to support efficient kNN search.\nLike most kNN algorithms, HNSW is an approximate method that sacrifices result accuracy for improved search speed.\nThis means the results returned are not always the true k closest neighbors.\n\nThe kNN search API supports restricting the search using a filter.\nThe search will return the top k documents that also match the filter query.\n\nA kNN search response has the exact same structure as a search API response.\nHowever, certain sections have a meaning specific to kNN search:\n\n* The document `_score` is determined by the similarity between the query and document vector.\n* The `hits.total` object contains the total number of nearest neighbor candidates considered, which is `num_candidates * num_shards`. The `hits.total.relation` will always be `eq`, indicating an exact value.", "docId": "search-knn", "docTag": "search", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/knn-search-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-knn-search", "name": "knn_search", "request": { "name": "Request", @@ -10862,7 +10862,7 @@ "docId": "delete-license", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-delete", "extDocId": "license-management", - "extDocUrl": "https://www.elastic.co/guide/en/kibana/current/managing-licenses.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/license/manage-your-license-in-self-managed-cluster", "name": "license.delete", "privileges": { "cluster": [ @@ -11128,7 +11128,7 @@ "docId": "logstash-api-delete-pipeline", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-logstash-delete-pipeline", "extDocId": "logstash-centralized-pipeline-management", - "extDocUrl": "https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html", + "extDocUrl": "https://www.elastic.co/docs/reference/logstash/logstash-centralized-pipeline-management", "name": "logstash.delete_pipeline", "privileges": { "cluster": [ @@ -11171,7 +11171,7 @@ "docId": "logstash-api-get-pipeline", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-logstash-get-pipeline", "extDocId": "logstash-centralized-pipeline-management", - "extDocUrl": "https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html", + "extDocUrl": "https://www.elastic.co/docs/reference/logstash/logstash-centralized-pipeline-management", "name": "logstash.get_pipeline", "privileges": { "cluster": [ @@ -11220,7 +11220,7 @@ "docId": "logstash-api-put-pipeline", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-logstash-put-pipeline", "extDocId": "logstash-centralized-pipeline-management", - "extDocUrl": "https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html", + "extDocUrl": "https://www.elastic.co/docs/reference/logstash/logstash-centralized-pipeline-management", "name": "logstash.put_pipeline", "privileges": { "cluster": [ @@ -14892,7 +14892,7 @@ "docTag": "search", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-msearch-template", "extDocId": "search-templates", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html", + "extDocUrl": "https://www.elastic.co/docs/solutions/search/search-templates", "name": "msearch_template", "privileges": { "index": [ @@ -15552,7 +15552,7 @@ "docTag": "script", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-put-script", "extDocId": "search-template", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html", + "extDocUrl": "https://www.elastic.co/docs/solutions/search/search-templates", "name": "put_script", "privileges": { "cluster": [ @@ -15688,7 +15688,7 @@ "docId": "query-rule-get", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-get-rule", "extDocId": "query-rule", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-using-query-rules.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/searching-with-query-rules", "name": "query_rules.get_rule", "privileges": { "cluster": [ @@ -15857,7 +15857,7 @@ "docId": "query-ruleset-put", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-put-ruleset", "extDocId": "query-rule", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-using-query-rules.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/searching-with-query-rules", "name": "query_rules.put_ruleset", "privileges": { "cluster": [ @@ -16477,7 +16477,7 @@ "description": "Run a script.\n\nRuns a script and returns a result.\nUse this API to build and test scripts, such as when defining a script for a runtime field.\nThis API requires very few dependencies and is especially useful if you don't have permissions to write documents on a cluster.\n\nThe API uses several _contexts_, which control how scripts are run, what variables are available at runtime, and what the return type is.\n\nEach context requires a script, but additional parameters depend on the context you're using for that script.", "docId": "painless-execute-api", "docTag": "script", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/painless/current/painless-execute-api.html", + "docUrl": "https://www.elastic.co/docs/reference/scripting-languages/painless/painless-api-examples", "name": "scripts_painless_execute", "request": { "name": "Request", @@ -16519,7 +16519,7 @@ "docTag": "search", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-scroll", "extDocId": "scroll-search-results", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#scroll-search-results", "name": "scroll", "privileges": { "index": [ @@ -16576,7 +16576,7 @@ "docId": "search-search", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search", "extDocId": "ccs-privileges", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/remote-clusters-cert.html#remote-clusters-privileges-ccs", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/remote-clusters/remote-clusters-cert#remote-clusters-privileges-ccs", "name": "search", "privileges": { "index": [ @@ -16845,7 +16845,7 @@ "docTag": "analytics", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-post-behavioral-analytics-event", "extDocId": "behavioral-analytics-event-reference", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/behavioral-analytics-event-reference.html", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/behavioral-analytics-event-reference.html", "name": "search_application.post_behavioral_analytics_event", "request": { "name": "Request", @@ -17144,7 +17144,7 @@ "docTag": "search", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-template", "extDocId": "search-template", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html", + "extDocUrl": "https://www.elastic.co/docs/solutions/search/search-templates", "name": "search_template", "privileges": { "index": [ @@ -17194,7 +17194,7 @@ "docId": "searchable-snapshots-api-cache-stats", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-searchable-snapshots-cache-stats", "extDocId": "searchable-snapshots", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/searchable-snapshots", "name": "searchable_snapshots.cache_stats", "privileges": { "cluster": [ @@ -17239,7 +17239,7 @@ "docId": "searchable-snapshots-api-clear-cache", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-searchable-snapshots-clear-cache", "extDocId": "searchable-snapshots", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/searchable-snapshots", "name": "searchable_snapshots.clear_cache", "privileges": { "cluster": [ @@ -17712,7 +17712,7 @@ "docId": "security-api-clear-cache", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-clear-cached-realms", "extDocId": "security-user-cache", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/controlling-user-cache.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-user-cache", "name": "security.clear_cached_realms", "request": { "name": "Request", @@ -17789,7 +17789,7 @@ "docId": "security-api-clear-service-token-caches", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-clear-cached-service-tokens", "extDocId": "service-accounts", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/service-accounts.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/service-accounts", "name": "security.clear_cached_service_tokens", "privileges": { "cluster": [ @@ -17832,7 +17832,7 @@ "docId": "security-api-create-api-key", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key", "extDocId": "security-settings-api-keys", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-settings.html#api-key-service-settings", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/security-settings#api-key-service-settings", "name": "security.create_api_key", "privileges": { "cluster": [ @@ -17874,7 +17874,7 @@ "docId": "security-api-cross-cluster-key", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-cross-cluster-api-key", "extDocId": "remote-clusters-api-key", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/remote-clusters-api-key.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/remote-clusters/remote-clusters-api-key", "name": "security.create_cross_cluster_api_key", "privileges": { "cluster": [ @@ -17919,7 +17919,7 @@ "docId": "security-api-create-service-token", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-service-token", "extDocId": "service-accounts", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/service-accounts.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/service-accounts", "name": "security.create_service_token", "privileges": { "cluster": [ @@ -17965,7 +17965,7 @@ "docId": "security-api-delegate-pki", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-delegate-pki", "extDocId": "pki-realm", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/pki-realm.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/pki", "name": "security.delegate_pki", "privileges": { "cluster": [ @@ -18008,7 +18008,7 @@ "docId": "security-api-delete-privilege", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-delete-privileges", "extDocId": "security-privileges", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/security-privileges", "name": "security.delete_privileges", "privileges": { "cluster": [ @@ -18091,7 +18091,7 @@ "docId": "security-api-delete-role-mapping", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-delete-role-mapping", "extDocId": "mapping-roles", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-roles.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/mapping-users-groups-to-roles", "name": "security.delete_role_mapping", "privileges": { "cluster": [ @@ -18134,7 +18134,7 @@ "docId": "security-api-delete-service-token", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-delete-service-token", "extDocId": "service-accounts", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/service-accounts.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/service-accounts", "name": "security.delete_service_token", "privileges": { "cluster": [ @@ -18483,7 +18483,7 @@ "docId": "security-api-get-builtin-privileges", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-builtin-privileges", "extDocId": "security-privileges", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/security-privileges", "name": "security.get_builtin_privileges", "privileges": { "cluster": [ @@ -18526,7 +18526,7 @@ "docId": "security-api-get-privileges", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-privileges", "extDocId": "security-privileges", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/security-privileges", "name": "security.get_privileges", "privileges": { "cluster": [ @@ -18627,7 +18627,7 @@ "docId": "security-api-get-role-mapping", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-role-mapping", "extDocId": "mapping-roles", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-roles.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/mapping-users-groups-to-roles", "name": "security.get_role_mapping", "privileges": { "cluster": [ @@ -18676,7 +18676,7 @@ "docId": "security-api-get-service-accounts", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-service-accounts", "extDocId": "service-accounts", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/service-accounts.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/service-accounts", "name": "security.get_service_accounts", "privileges": { "cluster": [ @@ -18731,7 +18731,7 @@ "docId": "security-api-get-service-credentials", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-service-credentials", "extDocId": "service-accounts", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/service-accounts.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/service-accounts", "name": "security.get_service_credentials", "privileges": { "cluster": [ @@ -18814,7 +18814,7 @@ "docId": "security-api-get-token", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-token", "extDocId": "security-encrypt-http", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-basic-setup-https.html#encrypt-http-communication", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/security/set-up-basic-security-plus-https#encrypt-http-communication", "name": "security.get_token", "privileges": { "cluster": [ @@ -19023,7 +19023,7 @@ "docId": "security-api-has-privileges", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-has-privileges", "extDocId": "security-privileges", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/security-privileges", "name": "security.has_privileges", "request": { "name": "Request", @@ -19072,7 +19072,7 @@ "docId": "security-api-has-privileges-profile", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-has-privileges-user-profile", "extDocId": "user-profile", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/user-profile.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/user-profiles", "name": "security.has_privileges_user_profile", "privileges": { "cluster": [ @@ -19308,7 +19308,7 @@ "docId": "security-api-put-privileges", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-privileges", "extDocId": "security-privileges", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/security-privileges", "name": "security.put_privileges", "privileges": { "cluster": [ @@ -19354,7 +19354,7 @@ "docId": "security-api-put-role", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-role", "extDocId": "defining-roles", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/defining-roles.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/defining-roles", "name": "security.put_role", "privileges": { "cluster": [ @@ -19401,7 +19401,7 @@ "docId": "security-api-put-role-mapping", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-role-mapping", "extDocId": "mapping-roles", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-roles.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/mapping-users-groups-to-roles", "name": "security.put_role_mapping", "privileges": { "cluster": [ @@ -19624,7 +19624,7 @@ "docId": "security-api-saml-authenticate", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-authenticate", "extDocId": "security-saml-guide", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/saml-guide-stack.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/saml", "name": "security.saml_authenticate", "request": { "name": "Request", @@ -19665,7 +19665,7 @@ "docId": "security-api-saml-complete-logout", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-complete-logout", "extDocId": "security-saml-guide", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/saml-guide-stack.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/saml", "name": "security.saml_complete_logout", "request": { "name": "Request", @@ -19706,7 +19706,7 @@ "docId": "security-api-saml-invalidate", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-invalidate", "extDocId": "security-saml-guide", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/saml-guide-stack.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/saml", "name": "security.saml_invalidate", "request": { "name": "Request", @@ -19747,7 +19747,7 @@ "docId": "security-api-saml-logout", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-logout", "extDocId": "security-saml-guide", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/saml-guide-stack.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/saml", "name": "security.saml_logout", "request": { "name": "Request", @@ -19788,7 +19788,7 @@ "docId": "security-api-saml-prepare-authentication", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-prepare-authentication", "extDocId": "security-saml-guide", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/saml-guide-stack.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/saml", "name": "security.saml_prepare_authentication", "request": { "name": "Request", @@ -19952,7 +19952,7 @@ "docId": "security-api-cross-cluster-key-update", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-update-cross-cluster-api-key", "extDocId": "remote-clusters-api-key", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/remote-clusters-api-key.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/remote-clusters/remote-clusters-api-key", "name": "security.update_cross_cluster_api_key", "privileges": { "cluster": [ @@ -20635,7 +20635,7 @@ "docId": "snapshot-repo-cleanup", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-cleanup-repository", "extDocId": "clean-up-snapshot-repo", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-register-repository.html#snapshots-repository-cleanup", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/self-managed#snapshots-repository-cleanup", "name": "snapshot.cleanup_repository", "privileges": { "cluster": [ @@ -20722,7 +20722,7 @@ "docId": "snapshot-create-api", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-create", "extDocId": "snapshot-create", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-take-snapshot.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/create-snapshots", "name": "snapshot.create", "privileges": { "cluster": [ @@ -20769,7 +20769,7 @@ "docId": "snapshot-repo-create", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-create-repository", "extDocId": "register-repository", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-register-repository.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/self-managed", "name": "snapshot.create_repository", "privileges": { "cluster": [ @@ -21061,7 +21061,7 @@ "docId": "snapshot-restore-api", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-restore", "extDocId": "restore-snapshot", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-restore-snapshot.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/restore-snapshot", "name": "snapshot.restore", "privileges": { "cluster": [ @@ -21160,7 +21160,7 @@ "docId": "snapshot-repo-verify", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-verify-repository", "extDocId": "verify-repository", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-register-repository.html#snapshots-repository-verification", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/self-managed#snapshots-repository-verification", "name": "snapshot.verify_repository", "privileges": { "cluster": [ @@ -21451,7 +21451,7 @@ "docTag": "security", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ssl-certificates", "extDocId": "security-encrypt-internode", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-basic-setup.html#encrypt-internode-communication", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/security/set-up-basic-security#encrypt-internode-communication", "name": "ssl.certificates", "privileges": { "cluster": [ @@ -22137,7 +22137,7 @@ "docId": "test-grok-pattern", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-text-structure-test-grok-pattern", "extDocId": "grok", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/grok.html", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/scripting/grok", "name": "text_structure.test_grok_pattern", "request": { "name": "Request", @@ -22873,7 +22873,7 @@ "docId": "watcher-api-activate-watch", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-activate-watch", "extDocId": "watcher-works", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/how-watcher-works.html", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/alerts-cases/watcher/how-watcher-works", "name": "watcher.activate_watch", "privileges": { "cluster": [ @@ -22912,7 +22912,7 @@ "docId": "watcher-api-deactivate-watch", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-deactivate-watch", "extDocId": "watcher-works", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/how-watcher-works.html", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/alerts-cases/watcher/how-watcher-works", "name": "watcher.deactivate_watch", "privileges": { "cluster": [ @@ -24999,7 +24999,7 @@ { "description": "Only perform the operation if the document has this primary term.", "extDocId": "optimistic-concurrency", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/optimistic-concurrency-control.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control", "name": "if_primary_term", "required": false, "type": { @@ -25013,7 +25013,7 @@ { "description": "Only perform the operation if the document has this sequence number.", "extDocId": "optimistic-concurrency", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/optimistic-concurrency-control.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control", "name": "if_seq_no", "required": false, "type": { @@ -25233,7 +25233,7 @@ { "description": "Only perform the operation if the document has this primary term.", "extDocId": "optimistic-concurrency", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/optimistic-concurrency-control.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control", "name": "if_primary_term", "required": false, "type": { @@ -25247,7 +25247,7 @@ { "description": "Only perform the operation if the document has this sequence number.", "extDocId": "optimistic-concurrency", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/optimistic-concurrency-control.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control", "name": "if_seq_no", "required": false, "type": { @@ -25702,7 +25702,7 @@ { "description": "The period to retain the search context for scrolling.", "extDocId": "scroll-search-results", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#scroll-search-results", "name": "scroll", "required": false, "type": { @@ -26307,7 +26307,7 @@ { "description": "If `true`, the request is real-time as opposed to near-real-time.", "docId": "realtime", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#realtime", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get", "name": "realtime", "required": false, "serverDefault": true, @@ -26335,7 +26335,7 @@ { "description": "A custom value used to route operations to a specific shard.", "extDocId": "routing", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#get-routing", + "extDocUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get#get-routing", "name": "routing", "required": false, "type": { @@ -26493,7 +26493,7 @@ { "description": "If `true`, the request is real-time as opposed to near-real-time.", "extDocId": "realtime", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#realtime", + "extDocUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get", "name": "realtime", "required": false, "serverDefault": true, @@ -26521,7 +26521,7 @@ { "description": "A custom value used to route operations to a specific shard.", "extDocId": "routing", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#get-routing", + "extDocUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get#get-routing", "name": "routing", "required": false, "type": { @@ -27096,7 +27096,7 @@ { "description": "Whether this field is registered as a metadata field.", "docId": "mapping-metadata", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-fields.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/document-metadata-fields", "name": "metadata_field", "required": false, "type": { @@ -27247,7 +27247,7 @@ }, "description": "Define ad-hoc runtime fields in the request similar to the way it is done in search requests.\nThese fields exist only as part of the query and take precedence over fields defined with the same name in the index mappings.", "docId": "runtime-search-request", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/runtime-search-request.html", + "docUrl": "https://www.elastic.co/docs/manage-data/data-store/mapping/define-runtime-fields-in-search-request", "name": "runtime_mappings", "required": false, "type": { @@ -27714,7 +27714,7 @@ { "description": "If `true`, the request is real-time as opposed to near-real-time.", "docId": "realtime", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#realtime", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get", "name": "realtime", "required": false, "serverDefault": true, @@ -27742,7 +27742,7 @@ { "description": "A custom value used to route operations to a specific shard.", "extDocId": "routing", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#get-routing", + "extDocUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get#get-routing", "name": "routing", "required": false, "type": { @@ -28363,7 +28363,7 @@ { "description": "A custom value used to route operations to a specific shard.", "extDocId": "routing", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#get-routing", + "extDocUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get#get-routing", "name": "routing", "required": false, "type": { @@ -30085,7 +30085,7 @@ { "description": "Only perform the operation if the document has this primary term.", "extDocId": "optimistic-concurrency", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/optimistic-concurrency-control.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control", "name": "if_primary_term", "required": false, "type": { @@ -30099,7 +30099,7 @@ { "description": "Only perform the operation if the document has this sequence number.", "extDocId": "optimistic-concurrency", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/optimistic-concurrency-control.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control", "name": "if_seq_no", "required": false, "type": { @@ -30465,7 +30465,7 @@ { "description": "The kNN query to run.", "extDocId": "query-dsl-knn-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-knn-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-knn-query", "name": "knn", "required": true, "type": { @@ -30942,7 +30942,7 @@ { "description": "If `true`, the request is real-time as opposed to near-real-time.", "docId": "realtime", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#realtime", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get", "name": "realtime", "required": false, "serverDefault": true, @@ -30994,7 +30994,7 @@ { "description": "A comma-separated list of source fields to exclude from the response.\nYou can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.", "docId": "mapping-source-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-source-field.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-source-field", "name": "_source_excludes", "required": false, "type": { @@ -31008,7 +31008,7 @@ { "description": "A comma-separated list of source fields to include in the response.\nIf this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter.\nIf the `_source` parameter is `false`, this parameter is ignored.", "docId": "mapping-source-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-source-field.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-source-field", "name": "_source_includes", "required": false, "type": { @@ -31408,7 +31408,7 @@ { "description": "If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests.", "docId": "ccs-network-delays", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-cross-cluster-search.html#ccs-network-delays", + "docUrl": "https://www.elastic.co/docs/solutions/search/cross-cluster-search#ccs-network-delays", "name": "ccs_minimize_roundtrips", "required": false, "serverDefault": true, @@ -32276,7 +32276,7 @@ { "description": "If true, the request is real-time as opposed to near-real-time.", "docId": "realtime", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#realtime", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get", "name": "realtime", "required": false, "serverDefault": true, @@ -33119,7 +33119,7 @@ "kind": "interface", "description": "Discounted cumulative gain (DCG)", "docId": "dcg", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-rank-eval.html#_discounted_cumulative_gain_dcg", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/search-rank-eval.html", "inherits": { "type": { "name": "RankEvalMetricBase", @@ -33152,7 +33152,7 @@ "kind": "interface", "description": "Expected Reciprocal Rank (ERR)", "docId": "expected-reciprocal", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-rank-eval.html#_expected_reciprocal_rank_err", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rank-eval#_expected_reciprocal_rank_err", "inherits": { "type": { "name": "RankEvalMetricBase", @@ -33183,7 +33183,7 @@ "kind": "interface", "description": "Mean Reciprocal Rank", "docId": "mean-reciprocal", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-rank-eval.html#_mean_reciprocal_rank", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/search-rank-eval.html#_mean_reciprocal_rank", "inherits": { "type": { "name": "RankEvalMetricRatingTreshold", @@ -33201,7 +33201,7 @@ "kind": "interface", "description": "Precision at K (P@k)", "docId": "k-precision", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-rank-eval.html#k-precision", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rank-eval#k-precision", "inherits": { "type": { "name": "RankEvalMetricRatingTreshold", @@ -33262,7 +33262,7 @@ "kind": "interface", "description": "Recall at K (R@k)", "docId": "k-recall", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-rank-eval.html#k-recall", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/search-rank-eval.html#k-recall", "inherits": { "type": { "name": "RankEvalMetricRatingTreshold", @@ -33973,7 +33973,7 @@ { "description": "The number of slices this task should be divided into.\nIt defaults to one slice, which means the task isn't sliced into subtasks.\n\nReindex supports sliced scroll to parallelize the reindexing process.\nThis parallelization can improve efficiency and provide a convenient way to break the request down into smaller parts.\n\nNOTE: Reindexing from remote clusters does not support manual or automatic slicing.\n\nIf set to `auto`, Elasticsearch chooses the number of slices to use.\nThis setting will use one slice per shard, up to a certain limit.\nIf there are multiple sources, it will choose the number of slices based on the index or backing index with the smallest number of shards.", "extDocId": "slice-scroll", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#slice-scroll", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#slice-scroll", "name": "slices", "required": false, "serverDefault": "1", @@ -35189,7 +35189,7 @@ { "description": "The period to retain the search context for scrolling.", "docId": "scroll-search-results", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#scroll-search-results", "name": "scroll", "required": false, "serverDefault": "1d", @@ -35254,7 +35254,7 @@ { "description": "The period to retain the search context for scrolling.", "docId": "scroll-search-results", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#scroll-search-results", "name": "scroll", "required": false, "serverDefault": "1d", @@ -35451,7 +35451,7 @@ { "description": "Boost the `_score` of documents from specified indices.\nThe boost value is the factor by which scores are multiplied.\nA boost value greater than `1.0` increases the score.\nA boost value between `0` and `1.0` decreases the score.", "extDocId": "relevance-scores", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html#relevance-scores", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl#relevance-scores", "name": "indices_boost", "required": false, "type": { @@ -35479,7 +35479,7 @@ { "description": "An array of wildcard (`*`) field patterns.\nThe request returns doc values for field names matching these patterns in the `hits.fields` property of the response.", "extDocId": "docvalue-fields", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-fields.html#docvalue-fields", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#docvalue-fields", "name": "docvalue_fields", "required": false, "type": { @@ -35502,7 +35502,7 @@ }, "description": "The approximate kNN search to run.", "extDocId": "knn-approximate", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/knn-search.html#approximate-knn", + "extDocUrl": "https://www.elastic.co/docs/solutions/search/vector/knn#approximate-knn", "name": "knn", "required": false, "type": { @@ -35585,7 +35585,7 @@ { "description": "The search definition using the Query DSL.", "extDocId": "query-dsl", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl", "name": "query", "required": false, "type": { @@ -35707,7 +35707,7 @@ { "description": "A comma-separated list of : pairs.", "extDocId": "sort-search-results", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results", "name": "sort", "required": false, "type": { @@ -35721,7 +35721,7 @@ { "description": "The source fields that are returned for matching documents.\nThese fields are returned in the `hits._source` property of the search response.\nIf the `stored_fields` property is specified, the `_source` property defaults to `false`.\nOtherwise, it defaults to `true`.", "extDocId": "source-filtering", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-fields.html#source-filtering", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#source-filtering", "name": "_source", "required": false, "type": { @@ -35813,7 +35813,7 @@ { "description": "If `true`, the request returns sequence number and primary term of the last modification of each hit.", "extDocId": "optimistic-concurrency", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/optimistic-concurrency-control.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control", "name": "seq_no_primary_term", "required": false, "type": { @@ -35827,7 +35827,7 @@ { "description": "A comma-separated list of stored fields to return as part of a hit.\nIf no fields are specified, no stored fields are included in the response.\nIf this field is specified, the `_source` property defaults to `false`.\nYou can pass `_source: true` to return both source fields and stored fields in the search response.", "extDocId": "stored-fields", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-fields.html#stored-fields", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#stored-fields", "name": "stored_fields", "required": false, "type": { @@ -35853,7 +35853,7 @@ { "description": "One or more runtime fields in the search request.\nThese fields take precedence over mapped fields with the same name.", "extDocId": "runtime-search-request", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/runtime-search-request.html", + "extDocUrl": "https://www.elastic.co/docs/manage-data/data-store/mapping/define-runtime-fields-in-search-request", "name": "runtime_mappings", "required": false, "type": { @@ -35991,7 +35991,7 @@ { "description": "If `true`, network round-trips between the coordinating node and the remote clusters are minimized when running cross-cluster search (CCS) requests.", "extDocId": "ccs-network-delays", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-cross-cluster-search.html#ccs-network-delays", + "extDocUrl": "https://www.elastic.co/docs/solutions/search/cross-cluster-search#ccs-network-delays", "name": "ccs_minimize_roundtrips", "required": false, "serverDefault": true, @@ -36031,7 +36031,7 @@ { "description": "A comma-separated list of fields to return as the docvalue representation of a field for each hit.", "extDocId": "docvalue-fields", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-fields.html#docvalue-fields", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#docvalue-fields", "name": "docvalue_fields", "required": false, "type": { @@ -36164,7 +36164,7 @@ { "description": "If `true`, the caching of search results is enabled for requests where `size` is `0`.\nIt defaults to index level settings.", "extDocId": "shard-request-cache", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/shard-request-cache.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/shard-request-cache", "name": "request_cache", "required": false, "type": { @@ -36190,7 +36190,7 @@ { "description": "The period to retain the search context for scrolling.\nBy default, this value cannot exceed `1d` (24 hours).\nYou can change this limit by using the `search.max_keep_alive` cluster-level setting.", "extDocId": "scroll-search-results", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#scroll-search-results", "name": "scroll", "required": false, "type": { @@ -36204,7 +36204,7 @@ { "description": "Indicates how distributed term frequencies are calculated for relevance scoring.", "extDocId": "relevance-scores", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html#relevance-scores", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl#relevance-scores", "name": "search_type", "required": false, "type": { @@ -36233,7 +36233,7 @@ { "description": "A comma-separated list of stored fields to return as part of a hit.\nIf no fields are specified, no stored fields are included in the response.\nIf this field is specified, the `_source` parameter defaults to `false`.\nYou can pass `_source: true` to return both source fields and stored fields in the search response.", "extDocId": "stored-fields", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-fields.html#stored-fields", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#stored-fields", "name": "stored_fields", "required": false, "type": { @@ -36423,7 +36423,7 @@ { "description": "If `true`, the request returns the sequence number and primary term of the last modification of each hit.", "extDocId": "optimistic-concurrency", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/optimistic-concurrency-control.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control", "name": "seq_no_primary_term", "required": false, "type": { @@ -36475,7 +36475,7 @@ { "description": "A comma-separated list of `:` pairs.", "extDocId": "sort-search-results", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results", "name": "sort", "required": false, "type": { @@ -36731,7 +36731,7 @@ { "description": "The identifier for the search and its search context.\nYou can use this scroll ID with the scroll API to retrieve the next batch of search results for the request.\nThis property is returned only if the `scroll` query parameter is specified in the request.", "extDocId": "scroll-search-results", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#scroll-search-results", "name": "_scroll_id", "required": false, "type": { @@ -37919,7 +37919,7 @@ ], "description": "Text or location that we want similar documents for or a lookup to a document's field for the text.", "docId": "document-input-parameters", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-mlt-query.html#_document_input_parameters", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-mlt-query#_document_input_parameters", "name": { "name": "Context", "namespace": "_global.search._types" @@ -38617,7 +38617,7 @@ { "kind": "interface", "extDocId": "collapse-search-results", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/collapse-search-results.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/collapse-search-results", "name": { "name": "FieldCollapse", "namespace": "_global.search._types" @@ -41199,7 +41199,7 @@ { "description": "Optional operators for the regular expression.", "docId": "regexp-syntax", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/regexp-syntax.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/regexp-syntax", "name": "flags", "required": false, "type": { @@ -41545,7 +41545,7 @@ { "description": "Boost the `_score` of documents from specified indices.\nThe boost value is the factor by which scores are multiplied.\nA boost value greater than `1.0` increases the score.\nA boost value between `0` and `1.0` decreases the score.", "extDocId": "relevance-scores", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html#relevance-scores", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl#relevance-scores", "name": "indices_boost", "required": false, "type": { @@ -41573,7 +41573,7 @@ { "description": "An array of wildcard (`*`) field patterns.\nThe request returns doc values for field names matching these patterns in the `hits.fields` property of the response.", "extDocId": "docvalue-fields", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-fields.html#docvalue-fields", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#docvalue-fields", "name": "docvalue_fields", "required": false, "type": { @@ -41596,7 +41596,7 @@ }, "description": "The approximate kNN search to run.", "extDocId": "knn-approximate", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/knn-search.html#approximate-knn", + "extDocUrl": "https://www.elastic.co/docs/solutions/search/vector/knn#approximate-knn", "name": "knn", "required": false, "type": { @@ -41679,7 +41679,7 @@ { "description": "The search definition using the Query DSL.", "extDocId": "query-dsl", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl", "name": "query", "required": false, "type": { @@ -41801,7 +41801,7 @@ { "description": "A comma-separated list of : pairs.", "extDocId": "sort-search-results", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results", "name": "sort", "required": false, "type": { @@ -41815,7 +41815,7 @@ { "description": "The source fields that are returned for matching documents.\nThese fields are returned in the `hits._source` property of the search response.\nIf the `stored_fields` property is specified, the `_source` property defaults to `false`.\nOtherwise, it defaults to `true`.", "extDocId": "source-filtering", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-fields.html#source-filtering", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#source-filtering", "name": "_source", "required": false, "type": { @@ -41907,7 +41907,7 @@ { "description": "If `true`, the request returns sequence number and primary term of the last modification of each hit.", "extDocId": "optimistic-concurrency", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/optimistic-concurrency-control.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control", "name": "seq_no_primary_term", "required": false, "type": { @@ -41921,7 +41921,7 @@ { "description": "A comma-separated list of stored fields to return as part of a hit.\nIf no fields are specified, no stored fields are included in the response.\nIf this field is specified, the `_source` property defaults to `false`.\nYou can pass `_source: true` to return both source fields and stored fields in the search response.", "extDocId": "stored-fields", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-fields.html#stored-fields", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#stored-fields", "name": "stored_fields", "required": false, "type": { @@ -41947,7 +41947,7 @@ { "description": "One or more runtime fields in the search request.\nThese fields take precedence over mapped fields with the same name.", "extDocId": "runtime-search-request", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/runtime-search-request.html", + "extDocUrl": "https://www.elastic.co/docs/manage-data/data-store/mapping/define-runtime-fields-in-search-request", "name": "runtime_mappings", "required": false, "type": { @@ -42400,7 +42400,7 @@ { "description": "The fuzziness factor.", "docId": "fuzziness", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/common-options#fuzziness", "name": "fuzziness", "required": false, "serverDefault": "AUTO", @@ -44348,7 +44348,7 @@ { "description": "Filter an index shard if the provided query rewrites to `match_none`.", "docId": "query-dsl", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html", + "docUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl", "name": "index_filter", "required": false, "type": { @@ -44640,7 +44640,7 @@ { "description": "Filter terms based on their tf-idf scores.\nThis could be useful in order find out a good characteristic vector of a document.\nThis feature works in a similar manner to the second phase of the More Like This Query.", "extDocId": "query-dsl-mlt-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-mlt-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-mlt-query", "name": "filter", "required": false, "type": { @@ -44939,7 +44939,7 @@ { "description": "If true, the request is real-time as opposed to near-real-time.", "docId": "realtime", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#realtime", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get", "name": "realtime", "required": false, "serverDefault": true, @@ -45481,7 +45481,7 @@ { "description": "Only perform the operation if the document has this primary term.", "extDocId": "optimistic-concurrency", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/optimistic-concurrency-control.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control", "name": "if_primary_term", "required": false, "type": { @@ -45495,7 +45495,7 @@ { "description": "Only perform the operation if the document has this sequence number.", "extDocId": "optimistic-concurrency", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/optimistic-concurrency-control.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control", "name": "if_seq_no", "required": false, "type": { @@ -47046,7 +47046,7 @@ { "kind": "type_alias", "docId": "byte-units", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#byte-units", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/api-conventions#byte-units", "name": { "name": "ByteSize", "namespace": "_types" @@ -47647,7 +47647,7 @@ { "kind": "type_alias", "docId": "mapping-date-format", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-date-format.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-date-format", "name": { "name": "DateFormat", "namespace": "_types" @@ -48693,7 +48693,7 @@ { "kind": "type_alias", "docId": "fuzziness", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/common-options#fuzziness", "name": { "name": "Fuzziness", "namespace": "_types" @@ -50028,7 +50028,7 @@ { "kind": "interface", "extDocId": "query-dsl-knn-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-knn-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-knn-query", "inherits": { "type": { "name": "QueryBase", @@ -50387,7 +50387,7 @@ { "description": "If defined, each search hit will contain inner hits.", "docId": "knn-inner-hits", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/knn-search.html#nested-knn-search-inner-hits", + "docUrl": "https://www.elastic.co/docs/solutions/search/vector/knn#nested-knn-search-inner-hits", "name": "inner_hits", "required": false, "type": { @@ -50775,7 +50775,7 @@ "kind": "type_alias", "description": "The minimum number of terms that should match as integer, percentage or range", "docId": "query-dsl-minimum-should-match", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-minimum-should-match", "name": { "name": "MinimumShouldMatch", "namespace": "_types" @@ -50804,7 +50804,7 @@ { "kind": "type_alias", "docId": "query-dsl-multi-term-rewrite", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-multi-term-rewrite", "name": { "name": "MultiTermQueryRewrite", "namespace": "_types" @@ -51061,7 +51061,7 @@ { "kind": "type_alias", "docId": "modules-node", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-node.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/node-settings", "name": { "name": "NodeName", "namespace": "_types" @@ -53900,7 +53900,7 @@ } ], "docId": "sort-search-results", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results", "name": { "name": "SortOptions", "namespace": "_types" @@ -55294,7 +55294,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-adjacency-matrix-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-adjacency-matrix-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-adjacency-matrix-aggregation", "inherits": { "generics": [ { @@ -55402,7 +55402,7 @@ { "kind": "type_alias", "extDocId": "search-aggregations", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations.html", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/aggregations", "name": { "name": "Aggregate", "namespace": "_types.aggregations" @@ -56039,7 +56039,7 @@ { "description": "A bucket aggregation returning a form of adjacency matrix.\nThe request provides a collection of named filter expressions, similar to the `filters` aggregation.\nEach bucket in the response represents a non-empty cell in the matrix of intersecting filters.", "extDocId": "search-aggregations-bucket-adjacency-matrix-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-adjacency-matrix-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-adjacency-matrix-aggregation", "name": "adjacency_matrix", "required": false, "type": { @@ -56053,7 +56053,7 @@ { "description": "A multi-bucket aggregation similar to the date histogram, except instead of providing an interval to use as the width of each bucket, a target number of buckets is provided.", "extDocId": "search-aggregations-bucket-autodatehistogram-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-autodatehistogram-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-autodatehistogram-aggregation", "name": "auto_date_histogram", "required": false, "type": { @@ -56067,7 +56067,7 @@ { "description": "A single-value metrics aggregation that computes the average of numeric values that are extracted from the aggregated documents.", "extDocId": "search-aggregations-metrics-avg-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-avg-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-avg-aggregation", "name": "avg", "required": false, "type": { @@ -56081,7 +56081,7 @@ { "description": "A sibling pipeline aggregation which calculates the mean value of a specified metric in a sibling aggregation.\nThe specified metric must be numeric and the sibling aggregation must be a multi-bucket aggregation.", "extDocId": "search-aggregations-pipeline-avg-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-avg-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-avg-bucket-aggregation", "name": "avg_bucket", "required": false, "type": { @@ -56095,7 +56095,7 @@ { "description": "A metrics aggregation that computes a box plot of numeric values extracted from the aggregated documents.", "extDocId": "search-aggregations-metrics-boxplot-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-boxplot-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-boxplot-aggregation", "name": "boxplot", "required": false, "type": { @@ -56109,7 +56109,7 @@ { "description": "A parent pipeline aggregation which runs a script which can perform per bucket computations on metrics in the parent multi-bucket aggregation.", "extDocId": "search-aggregations-pipeline-bucket-script-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-bucket-script-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-bucket-script-aggregation", "name": "bucket_script", "required": false, "type": { @@ -56123,7 +56123,7 @@ { "description": "A parent pipeline aggregation which runs a script to determine whether the current bucket will be retained in the parent multi-bucket aggregation.", "extDocId": "search-aggregations-pipeline-bucket-selector-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-bucket-selector-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-bucket-selector-aggregation", "name": "bucket_selector", "required": false, "type": { @@ -56137,7 +56137,7 @@ { "description": "A parent pipeline aggregation which sorts the buckets of its parent multi-bucket aggregation.", "extDocId": "search-aggregations-pipeline-bucket-sort-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-bucket-sort-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-bucket-sort-aggregation", "name": "bucket_sort", "required": false, "type": { @@ -56159,7 +56159,7 @@ }, "description": "A sibling pipeline aggregation which runs a two sample Kolmogorov–Smirnov test (\"K-S test\") against a provided distribution and the distribution implied by the documents counts in the configured sibling aggregation.", "extDocId": "search-aggregations-bucket-count-ks-test-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-count-ks-test-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-count-ks-test-aggregation", "name": "bucket_count_ks_test", "required": false, "type": { @@ -56181,7 +56181,7 @@ }, "description": "A sibling pipeline aggregation which runs a correlation function on the configured sibling multi-bucket aggregation.", "extDocId": "search-aggregations-bucket-correlation-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-correlation-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-correlation-aggregation", "name": "bucket_correlation", "required": false, "type": { @@ -56195,7 +56195,7 @@ { "description": "A single-value metrics aggregation that calculates an approximate count of distinct values.", "extDocId": "search-aggregations-metrics-cardinality-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-cardinality-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-cardinality-aggregation", "name": "cardinality", "required": false, "type": { @@ -56217,7 +56217,7 @@ }, "description": "A multi-bucket aggregation that groups semi-structured text into buckets.", "extDocId": "search-aggregations-bucket-categorize-text-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-categorize-text-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-categorize-text-aggregation", "name": "categorize_text", "required": false, "type": { @@ -56231,7 +56231,7 @@ { "description": "A single bucket aggregation that selects child documents that have the specified type, as defined in a `join` field.", "extDocId": "search-aggregations-bucket-children-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-children-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-children-aggregation", "name": "children", "required": false, "type": { @@ -56257,7 +56257,7 @@ { "description": "A parent pipeline aggregation which calculates the cumulative cardinality in a parent `histogram` or `date_histogram` aggregation.", "extDocId": "search-aggregations-pipeline-cumulative-cardinality-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-cumulative-cardinality-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-cumulative-cardinality-aggregation", "name": "cumulative_cardinality", "required": false, "type": { @@ -56271,7 +56271,7 @@ { "description": "A parent pipeline aggregation which calculates the cumulative sum of a specified metric in a parent `histogram` or `date_histogram` aggregation.", "extDocId": "search-aggregations-pipeline-cumulative-sum-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-cumulative-sum-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-cumulative-sum-aggregation", "name": "cumulative_sum", "required": false, "type": { @@ -56285,7 +56285,7 @@ { "description": "A multi-bucket values source based aggregation that can be applied on date values or date range values extracted from the documents.\nIt dynamically builds fixed size (interval) buckets over the values.", "extDocId": "search-aggregations-bucket-datehistogram-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-datehistogram-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-datehistogram-aggregation", "name": "date_histogram", "required": false, "type": { @@ -56299,7 +56299,7 @@ { "description": "A multi-bucket value source based aggregation that enables the user to define a set of date ranges - each representing a bucket.", "extDocId": "search-aggregations-bucket-daterange-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-daterange-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-daterange-aggregation", "name": "date_range", "required": false, "type": { @@ -56313,7 +56313,7 @@ { "description": "A parent pipeline aggregation which calculates the derivative of a specified metric in a parent `histogram` or `date_histogram` aggregation.", "extDocId": "search-aggregations-pipeline-derivative-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-derivative-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-derivative-aggregation", "name": "derivative", "required": false, "type": { @@ -56327,7 +56327,7 @@ { "description": "A filtering aggregation used to limit any sub aggregations' processing to a sample of the top-scoring documents.\nSimilar to the `sampler` aggregation, but adds the ability to limit the number of matches that share a common value.", "extDocId": "search-aggregations-bucket-diversified-sampler-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-diversified-sampler-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-diversified-sampler-aggregation", "name": "diversified_sampler", "required": false, "type": { @@ -56341,7 +56341,7 @@ { "description": "A multi-value metrics aggregation that computes stats over numeric values extracted from the aggregated documents.", "extDocId": "search-aggregations-metrics-extendedstats-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-extendedstats-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-extendedstats-aggregation", "name": "extended_stats", "required": false, "type": { @@ -56355,7 +56355,7 @@ { "description": "A sibling pipeline aggregation which calculates a variety of stats across all bucket of a specified metric in a sibling aggregation.", "extDocId": "search-aggregations-pipeline-extended-stats-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-extended-stats-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-extended-stats-bucket-aggregation", "name": "extended_stats_bucket", "required": false, "type": { @@ -56369,7 +56369,7 @@ { "description": "A bucket aggregation which finds frequent item sets, a form of association rules mining that identifies items that often occur together.", "extDocId": "search-aggregations-bucket-frequent-item-sets-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-frequent-item-sets-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-frequent-item-sets-aggregation", "name": "frequent_item_sets", "required": false, "type": { @@ -56383,7 +56383,7 @@ { "description": "A single bucket aggregation that narrows the set of documents to those that match a query.", "extDocId": "search-aggregations-bucket-filter-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filter-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-filter-aggregation", "name": "filter", "required": false, "type": { @@ -56397,7 +56397,7 @@ { "description": "A multi-bucket aggregation where each bucket contains the documents that match a query.", "extDocId": "search-aggregations-bucket-filters-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filters-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-filters-aggregation", "name": "filters", "required": false, "type": { @@ -56411,7 +56411,7 @@ { "description": "A metric aggregation that computes the geographic bounding box containing all values for a Geopoint or Geoshape field.", "extDocId": "search-aggregations-metrics-geobounds-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-geobounds-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-geobounds-aggregation", "name": "geo_bounds", "required": false, "type": { @@ -56425,7 +56425,7 @@ { "description": "A metric aggregation that computes the weighted centroid from all coordinate values for geo fields.", "extDocId": "search-aggregations-metrics-geocentroid-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-geocentroid-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-geocentroid-aggregation", "name": "geo_centroid", "required": false, "type": { @@ -56439,7 +56439,7 @@ { "description": "A multi-bucket aggregation that works on `geo_point` fields.\nEvaluates the distance of each document value from an origin point and determines the buckets it belongs to, based on ranges defined in the request.", "extDocId": "search-aggregations-bucket-geodistance-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-geodistance-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geodistance-aggregation", "name": "geo_distance", "required": false, "type": { @@ -56453,7 +56453,7 @@ { "description": "A multi-bucket aggregation that groups `geo_point` and `geo_shape` values into buckets that represent a grid.\nEach cell is labeled using a geohash which is of user-definable precision.", "extDocId": "search-aggregations-bucket-geohashgrid-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-geohashgrid-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geohashgrid-aggregation", "name": "geohash_grid", "required": false, "type": { @@ -56467,7 +56467,7 @@ { "description": "Aggregates all `geo_point` values within a bucket into a `LineString` ordered by the chosen sort field.", "extDocId": "search-aggregations-metrics-geo-line", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-geo-line.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-geo-line", "name": "geo_line", "required": false, "type": { @@ -56481,7 +56481,7 @@ { "description": "A multi-bucket aggregation that groups `geo_point` and `geo_shape` values into buckets that represent a grid.\nEach cell corresponds to a map tile as used by many online map sites.", "extDocId": "search-aggregations-bucket-geotilegrid-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-geotilegrid-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geotilegrid-aggregation", "name": "geotile_grid", "required": false, "type": { @@ -56495,7 +56495,7 @@ { "description": "A multi-bucket aggregation that groups `geo_point` and `geo_shape` values into buckets that represent a grid.\nEach cell corresponds to a H3 cell index and is labeled using the H3Index representation.", "extDocId": "search-aggregations-bucket-geohexgrid-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-geohexgrid-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geohexgrid-aggregation", "name": "geohex_grid", "required": false, "type": { @@ -56509,7 +56509,7 @@ { "description": "Defines a single bucket of all the documents within the search execution context.\nThis context is defined by the indices and the document types you’re searching on, but is not influenced by the search query itself.", "extDocId": "search-aggregations-bucket-global-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-global-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-global-aggregation", "name": "global", "required": false, "type": { @@ -56523,7 +56523,7 @@ { "description": "A multi-bucket values source based aggregation that can be applied on numeric values or numeric range values extracted from the documents.\nIt dynamically builds fixed size (interval) buckets over the values.", "extDocId": "search-aggregations-bucket-histogram-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-histogram-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-histogram-aggregation", "name": "histogram", "required": false, "type": { @@ -56537,7 +56537,7 @@ { "description": "A multi-bucket value source based aggregation that enables the user to define a set of IP ranges - each representing a bucket.", "extDocId": "search-aggregations-bucket-iprange-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-iprange-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-iprange-aggregation", "name": "ip_range", "required": false, "type": { @@ -56551,7 +56551,7 @@ { "description": "A bucket aggregation that groups documents based on the network or sub-network of an IP address.", "extDocId": "search-aggregations-bucket-ipprefix-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-ipprefix-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-ipprefix-aggregation", "name": "ip_prefix", "required": false, "type": { @@ -56565,7 +56565,7 @@ { "description": "A parent pipeline aggregation which loads a pre-trained model and performs inference on the collated result fields from the parent bucket aggregation.", "extDocId": "search-aggregations-pipeline-inference-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-inference-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-inference-bucket-aggregation", "name": "inference", "required": false, "type": { @@ -56590,7 +56590,7 @@ { "description": "A numeric aggregation that computes the following statistics over a set of document fields: `count`, `mean`, `variance`, `skewness`, `kurtosis`, `covariance`, and `covariance`.", "extDocId": "search-aggregations-matrix-stats-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-matrix-stats-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-matrix-stats-aggregation", "name": "matrix_stats", "required": false, "type": { @@ -56604,7 +56604,7 @@ { "description": "A single-value metrics aggregation that returns the maximum value among the numeric values extracted from the aggregated documents.", "extDocId": "search-aggregations-metrics-max-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-max-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-max-aggregation", "name": "max", "required": false, "type": { @@ -56618,7 +56618,7 @@ { "description": "A sibling pipeline aggregation which identifies the bucket(s) with the maximum value of a specified metric in a sibling aggregation and outputs both the value and the key(s) of the bucket(s).", "extDocId": "search-aggregations-pipeline-max-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-max-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-max-bucket-aggregation", "name": "max_bucket", "required": false, "type": { @@ -56632,7 +56632,7 @@ { "description": "A single-value aggregation that approximates the median absolute deviation of its search results.", "extDocId": "search-aggregations-metrics-median-absolute-deviation-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-median-absolute-deviation-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-median-absolute-deviation-aggregation", "name": "median_absolute_deviation", "required": false, "type": { @@ -56646,7 +56646,7 @@ { "description": "A single-value metrics aggregation that returns the minimum value among numeric values extracted from the aggregated documents.", "extDocId": "search-aggregations-metrics-min-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-min-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-min-aggregation", "name": "min", "required": false, "type": { @@ -56660,7 +56660,7 @@ { "description": "A sibling pipeline aggregation which identifies the bucket(s) with the minimum value of a specified metric in a sibling aggregation and outputs both the value and the key(s) of the bucket(s).", "extDocId": "search-aggregations-pipeline-min-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-min-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-min-bucket-aggregation", "name": "min_bucket", "required": false, "type": { @@ -56674,7 +56674,7 @@ { "description": "A field data based single bucket aggregation, that creates a bucket of all documents in the current document set context that are missing a field value (effectively, missing a field or having the configured NULL value set).", "extDocId": "search-aggregations-bucket-missing-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-missing-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-missing-aggregation", "name": "missing", "required": false, "type": { @@ -56699,7 +56699,7 @@ { "description": "Given an ordered series of percentiles, \"slides\" a window across those percentiles and computes cumulative percentiles.", "extDocId": "search-aggregations-pipeline-moving-percentiles-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-moving-percentiles-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-moving-percentiles-aggregation", "name": "moving_percentiles", "required": false, "type": { @@ -56713,7 +56713,7 @@ { "description": "Given an ordered series of data, \"slides\" a window across the data and runs a custom script on each window of data.\nFor convenience, a number of common functions are predefined such as `min`, `max`, and moving averages.", "extDocId": "search-aggregations-pipeline-movfn-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-movfn-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-movfn-aggregation", "name": "moving_fn", "required": false, "type": { @@ -56727,7 +56727,7 @@ { "description": "A multi-bucket value source based aggregation where buckets are dynamically built - one per unique set of values.", "extDocId": "search-aggregations-bucket-multi-terms-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-multi-terms-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-multi-terms-aggregation", "name": "multi_terms", "required": false, "type": { @@ -56741,7 +56741,7 @@ { "description": "A special single bucket aggregation that enables aggregating nested documents.", "extDocId": "search-aggregations-bucket-nested-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-nested-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-nested-aggregation", "name": "nested", "required": false, "type": { @@ -56755,7 +56755,7 @@ { "description": "A parent pipeline aggregation which calculates the specific normalized/rescaled value for a specific bucket value.", "extDocId": "search-aggregations-pipeline-normalize-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-normalize-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-normalize-aggregation", "name": "normalize", "required": false, "type": { @@ -56769,7 +56769,7 @@ { "description": "A special single bucket aggregation that selects parent documents that have the specified type, as defined in a `join` field.", "extDocId": "search-aggregations-bucket-parent-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-parent-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-parent-aggregation", "name": "parent", "required": false, "type": { @@ -56783,7 +56783,7 @@ { "description": "A multi-value metrics aggregation that calculates one or more percentile ranks over numeric values extracted from the aggregated documents.", "extDocId": "search-aggregations-metrics-percentile-rank-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-percentile-rank-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-percentile-rank-aggregation", "name": "percentile_ranks", "required": false, "type": { @@ -56797,7 +56797,7 @@ { "description": "A multi-value metrics aggregation that calculates one or more percentiles over numeric values extracted from the aggregated documents.", "extDocId": "search-aggregations-metrics-percentile-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-percentile-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-percentile-aggregation", "name": "percentiles", "required": false, "type": { @@ -56811,7 +56811,7 @@ { "description": "A sibling pipeline aggregation which calculates percentiles across all bucket of a specified metric in a sibling aggregation.", "extDocId": "search-aggregations-pipeline-percentiles-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-percentiles-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-percentiles-bucket-aggregation", "name": "percentiles_bucket", "required": false, "type": { @@ -56825,7 +56825,7 @@ { "description": "A multi-bucket value source based aggregation that enables the user to define a set of ranges - each representing a bucket.", "extDocId": "search-aggregations-bucket-range-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-range-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-range-aggregation", "name": "range", "required": false, "type": { @@ -56839,7 +56839,7 @@ { "description": "A multi-bucket value source based aggregation which finds \"rare\" terms — terms that are at the long-tail of the distribution and are not frequent.", "extDocId": "search-aggregations-bucket-rare-terms-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-rare-terms-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-rare-terms-aggregation", "name": "rare_terms", "required": false, "type": { @@ -56853,7 +56853,7 @@ { "description": "Calculates a rate of documents or a field in each bucket.\nCan only be used inside a `date_histogram` or `composite` aggregation.", "extDocId": "search-aggregations-metrics-rate-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-rate-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-rate-aggregation", "name": "rate", "required": false, "type": { @@ -56867,7 +56867,7 @@ { "description": "A special single bucket aggregation that enables aggregating on parent documents from nested documents.\nShould only be defined inside a `nested` aggregation.", "extDocId": "search-aggregations-bucket-reverse-nested-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-reverse-nested-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-reverse-nested-aggregation", "name": "reverse_nested", "required": false, "type": { @@ -56887,7 +56887,7 @@ }, "description": "A single bucket aggregation that randomly includes documents in the aggregated results.\nSampling provides significant speed improvement at the cost of accuracy.", "extDocId": "search-aggregations-random-sampler-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-random-sampler-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-random-sampler-aggregation", "name": "random_sampler", "required": false, "type": { @@ -56901,7 +56901,7 @@ { "description": "A filtering aggregation used to limit any sub aggregations' processing to a sample of the top-scoring documents.", "extDocId": "search-aggregations-bucket-sampler-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-sampler-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-sampler-aggregation", "name": "sampler", "required": false, "type": { @@ -56915,7 +56915,7 @@ { "description": "A metric aggregation that uses scripts to provide a metric output.", "extDocId": "search-aggregations-metrics-scripted-metric-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-scripted-metric-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-scripted-metric-aggregation", "name": "scripted_metric", "required": false, "type": { @@ -56929,7 +56929,7 @@ { "description": "An aggregation that subtracts values in a time series from themselves at different time lags or periods.", "extDocId": "search-aggregations-pipeline-serialdiff-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-serialdiff-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-serialdiff-aggregation", "name": "serial_diff", "required": false, "type": { @@ -56943,7 +56943,7 @@ { "description": "Returns interesting or unusual occurrences of terms in a set.", "extDocId": "search-aggregations-bucket-significantterms-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-significantterms-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-significantterms-aggregation", "name": "significant_terms", "required": false, "type": { @@ -56957,7 +56957,7 @@ { "description": "Returns interesting or unusual occurrences of free-text terms in a set.", "extDocId": "search-aggregations-bucket-significanttext-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-significanttext-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-significanttext-aggregation", "name": "significant_text", "required": false, "type": { @@ -56971,7 +56971,7 @@ { "description": "A multi-value metrics aggregation that computes stats over numeric values extracted from the aggregated documents.", "extDocId": "search-aggregations-metrics-stats-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-stats-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-stats-aggregation", "name": "stats", "required": false, "type": { @@ -56985,7 +56985,7 @@ { "description": "A sibling pipeline aggregation which calculates a variety of stats across all bucket of a specified metric in a sibling aggregation.", "extDocId": "search-aggregations-pipeline-stats-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-stats-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-stats-bucket-aggregation", "name": "stats_bucket", "required": false, "type": { @@ -56999,7 +56999,7 @@ { "description": "A multi-value metrics aggregation that computes statistics over string values extracted from the aggregated documents.", "extDocId": "search-aggregations-metrics-string-stats-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-string-stats-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-string-stats-aggregation", "name": "string_stats", "required": false, "type": { @@ -57013,7 +57013,7 @@ { "description": "A single-value metrics aggregation that sums numeric values that are extracted from the aggregated documents.", "extDocId": "search-aggregations-metrics-sum-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-sum-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-sum-aggregation", "name": "sum", "required": false, "type": { @@ -57027,7 +57027,7 @@ { "description": "A sibling pipeline aggregation which calculates the sum of a specified metric across all buckets in a sibling aggregation.", "extDocId": "search-aggregations-pipeline-sum-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-sum-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-sum-bucket-aggregation", "name": "sum_bucket", "required": false, "type": { @@ -57041,7 +57041,7 @@ { "description": "A multi-bucket value source based aggregation where buckets are dynamically built - one per unique value.", "extDocId": "search-aggregations-bucket-terms-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-terms-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-terms-aggregation", "name": "terms", "required": false, "type": { @@ -57063,7 +57063,7 @@ }, "description": "The time series aggregation queries data created using a time series index.\nThis is typically data such as metrics or other data streams with a time component, and requires creating an index using the time series mode.", "extDocId": "search-aggregations-bucket-time-series-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-time-series-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-time-series-aggregation", "name": "time_series", "required": false, "type": { @@ -57077,7 +57077,7 @@ { "description": "A metric aggregation that returns the top matching documents per bucket.", "extDocId": "search-aggregations-metrics-top-hits-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-top-hits-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-top-hits-aggregation", "name": "top_hits", "required": false, "type": { @@ -57091,7 +57091,7 @@ { "description": "A metrics aggregation that performs a statistical hypothesis test in which the test statistic follows a Student’s t-distribution under the null hypothesis on numeric values extracted from the aggregated documents.", "extDocId": "search-aggregations-metrics-ttest-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-ttest-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-ttest-aggregation", "name": "t_test", "required": false, "type": { @@ -57105,7 +57105,7 @@ { "description": "A metric aggregation that selects metrics from the document with the largest or smallest sort value.", "extDocId": "search-aggregations-metrics-top-metrics", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-top-metrics.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-top-metrics", "name": "top_metrics", "required": false, "type": { @@ -57119,7 +57119,7 @@ { "description": "A single-value metrics aggregation that counts the number of values that are extracted from the aggregated documents.", "extDocId": "search-aggregations-metrics-valuecount-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-valuecount-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-valuecount-aggregation", "name": "value_count", "required": false, "type": { @@ -57133,7 +57133,7 @@ { "description": "A single-value metrics aggregation that computes the weighted average of numeric values that are extracted from the aggregated documents.", "extDocId": "search-aggregations-metrics-weight-avg-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-weight-avg-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-weight-avg-aggregation", "name": "weighted_avg", "required": false, "type": { @@ -57147,7 +57147,7 @@ { "description": "A multi-bucket aggregation similar to the histogram, except instead of providing an interval to use as the width of each bucket, a target number of buckets is provided.", "extDocId": "search-aggregations-bucket-variablewidthhistogram-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-variablewidthhistogram-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-variablewidthhistogram-aggregation", "name": "variable_width_histogram", "required": false, "type": { @@ -57293,7 +57293,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-autodatehistogram-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-autodatehistogram-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-autodatehistogram-aggregation", "inherits": { "generics": [ { @@ -57332,7 +57332,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-autodatehistogram-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-autodatehistogram-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-autodatehistogram-aggregation", "inherits": { "type": { "name": "BucketAggregationBase", @@ -57479,7 +57479,7 @@ { "kind": "interface", "extDocId": "search-aggregations-pipeline-avg-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-avg-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-avg-bucket-aggregation", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -57496,7 +57496,7 @@ { "kind": "interface", "extDocId": "search-aggregations-metrics-avg-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-avg-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-avg-aggregation", "inherits": { "type": { "name": "SingleMetricAggregateBase", @@ -57514,7 +57514,7 @@ { "kind": "interface", "extDocId": "search-aggregations-metrics-boxplot-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-boxplot-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-boxplot-aggregation", "inherits": { "type": { "name": "AggregateBase", @@ -57732,7 +57732,7 @@ "kind": "interface", "description": "A sibling pipeline aggregation which executes a correlation function on the configured sibling multi-bucket aggregation.", "extDocId": "search-aggregations-bucket-correlation-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-correlation-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-correlation-aggregation", "inherits": { "type": { "name": "BucketPathAggregation", @@ -57859,7 +57859,7 @@ "kind": "interface", "description": "A sibling pipeline aggregation which executes a two sample Kolmogorov–Smirnov test (referred\nto as a \"K-S test\" from now on) against a provided distribution, and the distribution implied\nby the documents counts in the configured sibling aggregation. Specifically, for some metric,\nassuming that the percentile intervals of the metric are known beforehand or have been computed\nby an aggregation, then one would use range aggregation for the sibling to compute the p-value\nof the distribution difference between the metric and the restriction of that metric to a subset\nof the documents. A natural use case is if the sibling aggregation range aggregation nested in a\nterms aggregation, in which case one compares the overall distribution of metric to its restriction\nto each term.", "extDocId": "search-aggregations-bucket-count-ks-test-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-count-ks-test-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-count-ks-test-aggregation", "inherits": { "type": { "name": "BucketPathAggregation", @@ -57963,7 +57963,7 @@ { "description": "Path to the buckets that contain one set of values to correlate.", "docId": "search-aggregations-pipeline-bucket-path", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline.html#buckets-path-syntax", + "docUrl": "https://www.elastic.co/docs/reference/aggregations/pipeline#buckets-path-syntax", "name": "buckets_path", "required": false, "type": { @@ -57980,7 +57980,7 @@ { "kind": "interface", "extDocId": "search-aggregations-pipeline-bucket-script-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-bucket-script-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-bucket-script-aggregation", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -58010,7 +58010,7 @@ { "kind": "interface", "extDocId": "search-aggregations-pipeline-bucket-selector-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-bucket-selector-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-bucket-selector-aggregation", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -58040,7 +58040,7 @@ { "kind": "interface", "extDocId": "search-aggregations-pipeline-bucket-sort-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-bucket-sort-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-bucket-sort-aggregation", "inherits": { "type": { "name": "Aggregation", @@ -58067,7 +58067,7 @@ { "description": "The policy to apply when gaps are found in the data.", "docId": "gap-policy", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline.html#gap-policy", + "docUrl": "https://www.elastic.co/docs/reference/aggregations/pipeline#gap-policy", "name": "gap_policy", "required": false, "serverDefault": "skip", @@ -58094,7 +58094,7 @@ { "description": "The list of fields to sort on.", "docId": "sort-search-results", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results", "name": "sort", "required": false, "type": { @@ -58386,7 +58386,7 @@ "kind": "interface", "description": "A multi-bucket aggregation that groups semi-structured text into buckets. Each text\nfield is re-analyzed using a custom analyzer. The resulting tokens are then categorized\ncreating buckets of similarly formatted text values. This aggregation works best with machine\ngenerated text like system logs. Only the first 100 analyzed tokens are used to categorize the text.", "extDocId": "search-aggregations-bucket-categorize-text-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-categorize-text-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-categorize-text-aggregation", "inherits": { "type": { "name": "Aggregation", @@ -58465,7 +58465,9 @@ } }, { - "description": "The categorization analyzer specifies how the text is analyzed and tokenized before being categorized.\nThe syntax is very similar to that used to define the analyzer in the [Analyze endpoint](https://www.elastic.co/guide/en/elasticsearch/reference/8.0/indices-analyze.html). This property\ncannot be used at the same time as categorization_filters.", + "description": "The categorization analyzer specifies how the text is analyzed and tokenized before being categorized.\nThe syntax is very similar to that used to define the analyzer in the analyze API. This property\ncannot be used at the same time as `categorization_filters`.", + "extDocId": "indices-analyze", + "extDocUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-analyze", "name": "categorization_analyzer", "required": false, "type": { @@ -58526,7 +58528,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L1117-L1182" + "specLocation": "_types/aggregations/bucket.ts#L1117-L1183" }, { "kind": "type_alias", @@ -58538,7 +58540,7 @@ "name": "CategorizeTextAnalyzer", "namespace": "_types.aggregations" }, - "specLocation": "_types/aggregations/bucket.ts#L1184-L1187", + "specLocation": "_types/aggregations/bucket.ts#L1185-L1188", "type": { "kind": "union_of", "items": [ @@ -58599,7 +58601,7 @@ "AdditionalProperties" ], "extDocId": "search-aggregations-bucket-children-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-children-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-children-aggregation", "inherits": { "type": { "name": "SingleBucketAggregateBase", @@ -58708,7 +58710,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-composite-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-composite-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-composite-aggregation", "inherits": { "type": { "name": "BucketAggregationBase", @@ -59136,7 +59138,7 @@ { "kind": "interface", "extDocId": "search-aggregations-pipeline-cumulative-cardinality-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-cumulative-cardinality-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-cumulative-cardinality-aggregation", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -59153,7 +59155,7 @@ { "kind": "interface", "extDocId": "search-aggregations-pipeline-cumulative-sum-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-cumulative-sum-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-cumulative-sum-aggregation", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -59214,12 +59216,12 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L1189-L1193" + "specLocation": "_types/aggregations/bucket.ts#L1190-L1194" }, { "kind": "interface", "extDocId": "search-aggregations-bucket-datehistogram-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-datehistogram-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-datehistogram-aggregation", "inherits": { "generics": [ { @@ -59519,7 +59521,7 @@ "kind": "interface", "description": "Result of a `date_range` aggregation. Same format as a for a `range` aggregation: `from` and `to`\nin `buckets` are milliseconds since the Epoch, represented as a floating point number.", "extDocId": "search-aggregations-bucket-daterange-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-daterange-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-daterange-aggregation", "inherits": { "type": { "name": "RangeAggregate", @@ -59674,7 +59676,7 @@ { "kind": "interface", "extDocId": "search-aggregations-pipeline-derivative-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-derivative-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-derivative-aggregation", "inherits": { "type": { "name": "SingleMetricAggregateBase", @@ -59730,7 +59732,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-diversified-sampler-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-diversified-sampler-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-diversified-sampler-aggregation", "inherits": { "type": { "name": "BucketAggregationBase", @@ -59973,7 +59975,7 @@ { "kind": "interface", "extDocId": "search-aggregations-metrics-extendedstats-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-extendedstats-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-extendedstats-aggregation", "inherits": { "type": { "name": "StatsAggregate", @@ -60337,7 +60339,7 @@ "AdditionalProperties" ], "extDocId": "search-aggregations-bucket-filter-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filter-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-filter-aggregation", "inherits": { "type": { "name": "SingleBucketAggregateBase", @@ -60355,7 +60357,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-filters-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filters-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-filters-aggregation", "inherits": { "generics": [ { @@ -60554,7 +60556,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-frequent-item-sets-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-frequent-item-sets-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-frequent-item-sets-aggregation", "name": { "name": "FrequentItemSetsAggregation", "namespace": "_types.aggregations" @@ -60627,7 +60629,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L1240-L1267" + "specLocation": "_types/aggregations/bucket.ts#L1241-L1268" }, { "kind": "interface", @@ -60727,7 +60729,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L1226-L1238" + "specLocation": "_types/aggregations/bucket.ts#L1227-L1239" }, { "kind": "enum", @@ -60754,7 +60756,7 @@ { "kind": "interface", "extDocId": "search-aggregations-metrics-geobounds-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-geobounds-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-geobounds-aggregation", "inherits": { "type": { "name": "AggregateBase", @@ -60784,7 +60786,7 @@ { "kind": "interface", "extDocId": "search-aggregations-metrics-geobounds-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-geobounds-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-geobounds-aggregation", "inherits": { "type": { "name": "MetricAggregationBase", @@ -60815,7 +60817,7 @@ { "kind": "interface", "extDocId": "search-aggregations-metrics-geocentroid-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-geocentroid-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-geocentroid-aggregation", "inherits": { "type": { "name": "AggregateBase", @@ -60895,7 +60897,7 @@ "kind": "interface", "description": "Result of a `geo_distance` aggregation. The unit for `from` and `to` is meters by default.", "extDocId": "search-aggregations-bucket-geodistance-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-geodistance-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geodistance-aggregation", "inherits": { "type": { "name": "RangeAggregate", @@ -61019,7 +61021,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-geohashgrid-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-geohashgrid-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geohashgrid-aggregation", "inherits": { "type": { "name": "BucketAggregationBase", @@ -61184,7 +61186,7 @@ { "kind": "interface", "extDocId": "search-aggregations-metrics-geo-line", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-geo-line.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-geo-line", "inherits": { "type": { "name": "AggregateBase", @@ -61348,7 +61350,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-geotilegrid-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-geotilegrid-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geotilegrid-aggregation", "inherits": { "generics": [ { @@ -61564,7 +61566,7 @@ "AdditionalProperties" ], "extDocId": "search-aggregations-bucket-global-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-global-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-global-aggregation", "inherits": { "type": { "name": "SingleBucketAggregateBase", @@ -61673,7 +61675,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-histogram-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-histogram-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-histogram-aggregation", "inherits": { "generics": [ { @@ -62129,7 +62131,7 @@ } ], "extDocId": "search-aggregations-pipeline-inference-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-inference-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-inference-bucket-aggregation", "inherits": { "type": { "name": "AggregateBase", @@ -62396,7 +62398,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-ipprefix-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-ipprefix-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-ipprefix-aggregation", "inherits": { "generics": [ { @@ -62509,7 +62511,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L1195-L1224" + "specLocation": "_types/aggregations/bucket.ts#L1196-L1225" }, { "kind": "interface", @@ -62577,7 +62579,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-iprange-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-iprange-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-iprange-aggregation", "inherits": { "generics": [ { @@ -63034,7 +63036,7 @@ { "kind": "interface", "extDocId": "search-aggregations-matrix-stats-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-matrix-stats-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-matrix-stats-aggregation", "inherits": { "type": { "name": "AggregateBase", @@ -63227,7 +63229,7 @@ { "kind": "interface", "extDocId": "search-aggregations-metrics-max-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-max-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-max-aggregation", "inherits": { "type": { "name": "SingleMetricAggregateBase", @@ -63260,7 +63262,7 @@ { "kind": "interface", "extDocId": "search-aggregations-pipeline-max-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-max-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-max-bucket-aggregation", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -63293,7 +63295,7 @@ { "kind": "interface", "extDocId": "search-aggregations-metrics-median-absolute-deviation-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-median-absolute-deviation-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-median-absolute-deviation-aggregation", "inherits": { "type": { "name": "FormatMetricAggregationBase", @@ -63369,7 +63371,7 @@ { "kind": "interface", "extDocId": "search-aggregations-metrics-min-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-min-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-min-aggregation", "inherits": { "type": { "name": "SingleMetricAggregateBase", @@ -63402,7 +63404,7 @@ { "kind": "interface", "extDocId": "search-aggregations-pipeline-min-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-min-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-min-bucket-aggregation", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -63491,7 +63493,7 @@ "AdditionalProperties" ], "extDocId": "search-aggregations-bucket-missing-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-missing-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-missing-aggregation", "inherits": { "type": { "name": "SingleBucketAggregateBase", @@ -63668,7 +63670,7 @@ { "kind": "interface", "extDocId": "search-aggregations-pipeline-movfn-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-movfn-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-movfn-aggregation", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -63723,7 +63725,7 @@ { "kind": "interface", "extDocId": "search-aggregations-pipeline-moving-percentiles-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-moving-percentiles-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-moving-percentiles-aggregation", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -63906,7 +63908,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-multi-terms-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-multi-terms-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-multi-terms-aggregation", "inherits": { "generics": [ { @@ -64145,7 +64147,7 @@ "AdditionalProperties" ], "extDocId": "search-aggregations-bucket-nested-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-nested-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-nested-aggregation", "inherits": { "type": { "name": "SingleBucketAggregateBase", @@ -64191,7 +64193,7 @@ { "kind": "interface", "extDocId": "search-aggregations-pipeline-normalize-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-normalize-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-normalize-aggregation", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -64259,7 +64261,7 @@ "AdditionalProperties" ], "extDocId": "search-aggregations-bucket-parent-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-parent-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-parent-aggregation", "inherits": { "type": { "name": "SingleBucketAggregateBase", @@ -64314,7 +64316,7 @@ { "kind": "interface", "extDocId": "search-aggregations-metrics-percentile-rank-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-percentile-rank-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-percentile-rank-aggregation", "inherits": { "type": { "name": "FormatMetricAggregationBase", @@ -64541,7 +64543,7 @@ { "kind": "interface", "extDocId": "search-aggregations-pipeline-percentiles-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-percentiles-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-percentiles-bucket-aggregation", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -64599,7 +64601,7 @@ { "description": "Policy to apply when gaps are found in the data.", "docId": "gap-policy", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline.html#gap-policy", + "docUrl": "https://www.elastic.co/docs/reference/aggregations/pipeline#gap-policy", "name": "gap_policy", "required": false, "serverDefault": "skip", @@ -64617,7 +64619,7 @@ { "kind": "interface", "extDocId": "search-aggregations-random-sampler-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-random-sampler-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-random-sampler-aggregation", "inherits": { "type": { "name": "BucketAggregationBase", @@ -64676,7 +64678,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-range-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-range-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-range-aggregation", "inherits": { "generics": [ { @@ -64867,7 +64869,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-rare-terms-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-rare-terms-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-rare-terms-aggregation", "inherits": { "type": { "name": "BucketAggregationBase", @@ -64970,7 +64972,7 @@ { "kind": "interface", "extDocId": "search-aggregations-metrics-rate-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-rate-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-rate-aggregation", "inherits": { "type": { "name": "AggregateBase", @@ -65073,7 +65075,7 @@ "AdditionalProperties" ], "extDocId": "search-aggregations-bucket-reverse-nested-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-reverse-nested-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-reverse-nested-aggregation", "inherits": { "type": { "name": "SingleBucketAggregateBase", @@ -65138,7 +65140,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-sampler-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-sampler-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-sampler-aggregation", "inherits": { "type": { "name": "BucketAggregationBase", @@ -65212,7 +65214,7 @@ { "kind": "interface", "extDocId": "search-aggregations-metrics-scripted-metric-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-scripted-metric-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-scripted-metric-aggregation", "inherits": { "type": { "name": "AggregateBase", @@ -65321,7 +65323,7 @@ { "kind": "interface", "extDocId": "search-aggregations-pipeline-serialdiff-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-serialdiff-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-serialdiff-aggregation", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -65472,7 +65474,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-significanttext-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-significanttext-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-significanttext-aggregation", "generics": [ { "name": "T", @@ -65527,7 +65529,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-significanttext-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-significanttext-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-significanttext-aggregation", "inherits": { "type": { "name": "BucketAggregationBase", @@ -65767,7 +65769,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-significanttext-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-significanttext-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-significanttext-aggregation", "inherits": { "type": { "name": "BucketAggregationBase", @@ -66376,7 +66378,7 @@ "kind": "interface", "description": "Statistics aggregation result. `min`, `max` and `avg` are missing if there were no values to process\n(`count` is zero).", "extDocId": "search-aggregations-metrics-stats-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-stats-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-stats-aggregation", "inherits": { "type": { "name": "AggregateBase", @@ -66545,7 +66547,7 @@ { "kind": "interface", "extDocId": "search-aggregations-pipeline-stats-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-stats-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-stats-bucket-aggregation", "inherits": { "type": { "name": "StatsAggregate", @@ -66907,7 +66909,7 @@ "kind": "interface", "description": "Sum aggregation result. `value` is always present and is zero if there were no values to process.", "extDocId": "search-aggregations-metrics-sum-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-sum-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-sum-aggregation", "inherits": { "type": { "name": "SingleMetricAggregateBase", @@ -66940,7 +66942,7 @@ { "kind": "interface", "extDocId": "search-aggregations-pipeline-sum-bucket-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-sum-bucket-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-sum-bucket-aggregation", "inherits": { "type": { "name": "PipelineAggregationBase", @@ -67011,7 +67013,7 @@ { "kind": "interface", "extDocId": "search-aggregations-metrics-ttest-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-ttest-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-ttest-aggregation", "inherits": { "type": { "name": "AggregateBase", @@ -67192,7 +67194,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-terms-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-terms-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-terms-aggregation", "inherits": { "type": { "name": "BucketAggregationBase", @@ -67662,7 +67664,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-time-series-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-time-series-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-time-series-aggregation", "inherits": { "type": { "name": "BucketAggregationBase", @@ -67746,7 +67748,7 @@ { "kind": "interface", "extDocId": "search-aggregations-metrics-top-hits-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-top-hits-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-top-hits-aggregation", "inherits": { "type": { "name": "AggregateBase", @@ -68076,7 +68078,7 @@ { "kind": "interface", "extDocId": "search-aggregations-metrics-top-metrics", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-top-metrics.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-top-metrics", "inherits": { "type": { "name": "MetricAggregationBase", @@ -68266,7 +68268,7 @@ "kind": "interface", "description": "Value count aggregation result. `value` is always present.", "extDocId": "search-aggregations-metrics-valuecount-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-valuecount-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-valuecount-aggregation", "inherits": { "type": { "name": "SingleMetricAggregateBase", @@ -68364,7 +68366,7 @@ { "kind": "interface", "extDocId": "search-aggregations-bucket-variablewidthhistogram-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-variablewidthhistogram-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-variablewidthhistogram-aggregation", "name": { "name": "VariableWidthHistogramAggregation", "namespace": "_types.aggregations" @@ -68630,7 +68632,7 @@ "kind": "interface", "description": "Weighted average aggregation result. `value` is missing if the weight was set to zero.", "extDocId": "search-aggregations-metrics-weight-avg-aggregation", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-weight-avg-aggregation.html", + "extDocUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-weight-avg-aggregation", "inherits": { "type": { "name": "SingleMetricAggregateBase", @@ -69422,7 +69424,7 @@ "definition" ], "extDocId": "analysis-charfilters", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-charfilters.html", + "extDocUrl": "https://www.elastic.co/docs/reference/text-analysis/character-filter-reference", "name": { "name": "CharFilter", "namespace": "_types.analysis" @@ -73291,7 +73293,7 @@ { "kind": "type_alias", "docId": "analysis-normalizers", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-normalizers.html", + "docUrl": "https://www.elastic.co/docs/reference/text-analysis/normalizers", "name": { "name": "Normalizer", "namespace": "_types.analysis" @@ -75638,7 +75640,7 @@ "definition" ], "extDocId": "analysis-tokenfilters", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenfilters.html", + "extDocUrl": "https://www.elastic.co/docs/reference/text-analysis/token-filter-reference", "name": { "name": "TokenFilter", "namespace": "_types.analysis" @@ -76039,7 +76041,7 @@ "definition" ], "extDocId": "analysis-tokenizers", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenizers.html", + "extDocUrl": "https://www.elastic.co/docs/reference/text-analysis/tokenizer-reference", "name": { "name": "Tokenizer", "namespace": "_types.analysis" @@ -79192,7 +79194,7 @@ "kind": "interface", "description": "The `geo_shape` data type facilitates the indexing of and searching with arbitrary geo shapes such as rectangles\nand polygons.", "docId": "geo-shape", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/geo-shape.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/geo-shape", "inherits": { "type": { "name": "DocValuesPropertyBase", @@ -80132,7 +80134,7 @@ { "description": "Multi-fields allow the same string value to be indexed in multiple ways for different purposes, such as one\nfield for search and a multi-field for sorting and aggregations, or the same string value analyzed by different analyzers.", "docId": "multi-fields", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/multi-fields.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/multi-fields", "name": "fields", "required": false, "type": { @@ -80157,7 +80159,7 @@ { "description": "Metadata about the field.", "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-meta-field", "name": "meta", "required": false, "type": { @@ -81000,7 +81002,7 @@ { "description": "Metadata about the field.", "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-meta-field", "name": "meta", "required": false, "type": { @@ -81290,7 +81292,7 @@ { "description": "A custom format for `date` type runtime fields.", "docId": "mapping-date-format", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-date-format.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-date-format", "name": "format", "required": false, "type": { @@ -81713,7 +81715,7 @@ "kind": "interface", "description": "The `shape` data type facilitates the indexing of and searching with arbitrary `x, y` cartesian shapes such as\nrectangles and polygons.", "docId": "shape", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/shape.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/shape", "inherits": { "type": { "name": "DocValuesPropertyBase", @@ -82560,7 +82562,7 @@ }, { "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-meta-field", "name": "_meta", "required": false, "type": { @@ -82804,7 +82806,7 @@ { "kind": "interface", "extDocId": "query-dsl-bool-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-bool-query", "inherits": { "type": { "name": "QueryBase", @@ -82846,7 +82848,7 @@ { "description": "Specifies the number or percentage of `should` clauses returned documents must match.", "docId": "query-dsl-minimum-should-match", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-minimum-should-match", "name": "minimum_should_match", "required": false, "type": { @@ -82944,7 +82946,7 @@ { "kind": "interface", "extDocId": "query-dsl-boosting-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-boosting-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-boosting-query", "inherits": { "type": { "name": "QueryBase", @@ -83105,7 +83107,7 @@ { "description": "Minimum number of clauses that must match for a document to be returned.", "extDocId": "query-dsl-minimum-should-match", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-minimum-should-match", "name": "minimum_should_match", "required": false, "type": { @@ -83236,7 +83238,7 @@ { "kind": "interface", "extDocId": "query-dsl-constant-score-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-constant-score-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-constant-score-query", "inherits": { "type": { "name": "QueryBase", @@ -83584,7 +83586,7 @@ { "kind": "interface", "extDocId": "query-dsl-dis-max-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-dis-max-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-dis-max-query", "inherits": { "type": { "name": "QueryBase", @@ -83635,7 +83637,7 @@ "date" ], "extDocId": "query-dsl-distance-feature-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-distance-feature-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-distance-feature-query", "name": { "name": "DistanceFeatureQuery", "namespace": "_types.query_dsl" @@ -83740,7 +83742,7 @@ { "kind": "interface", "extDocId": "query-dsl-exists-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-exists-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-exists-query", "inherits": { "type": { "name": "QueryBase", @@ -84162,7 +84164,7 @@ { "kind": "interface", "extDocId": "query-dsl-function-score-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-function-score-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-function-score-query", "inherits": { "type": { "name": "QueryBase", @@ -84258,7 +84260,7 @@ { "kind": "interface", "extDocId": "query-dsl-fuzzy-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-fuzzy-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-fuzzy-query", "inherits": { "type": { "name": "QueryBase", @@ -84299,7 +84301,7 @@ { "description": "Number of beginning characters left unchanged when creating expansions.", "docId": "query-dsl-multi-term-rewrite", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-multi-term-rewrite", "name": "rewrite", "required": false, "serverDefault": "constant_score", @@ -84327,7 +84329,7 @@ { "description": "Maximum edit distance allowed for matching.", "docId": "fuzziness", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/common-options#fuzziness", "name": "fuzziness", "required": false, "type": { @@ -84407,7 +84409,7 @@ } ], "extDocId": "query-dsl-geo-bounding-box-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-bounding-box-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-bounding-box-query", "inherits": { "type": { "name": "QueryBase", @@ -84562,7 +84564,7 @@ } ], "extDocId": "query-dsl-geo-distance-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-distance-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-distance-query", "inherits": { "type": { "name": "QueryBase", @@ -84577,7 +84579,7 @@ { "description": "The radius of the circle centred on the specified location.\nPoints which fall into this circle are considered to be matches.", "docId": "distance-units", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#distance-units", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/api-conventions#distance-units", "name": "distance", "required": true, "type": { @@ -84760,7 +84762,7 @@ "version": "7.12.0" }, "extDocId": "query-dsl-geo-polygon-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-polygon-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-polygon-query", "inherits": { "type": { "name": "QueryBase", @@ -84878,7 +84880,7 @@ } ], "extDocId": "query-dsl-geo-shape-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-shape-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-shape-query", "inherits": { "type": { "name": "QueryBase", @@ -84930,7 +84932,7 @@ { "kind": "interface", "extDocId": "query-dsl-has-child-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-has-child-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-has-child-query", "inherits": { "type": { "name": "QueryBase", @@ -84958,7 +84960,7 @@ { "description": "If defined, each search hit will contain inner hits.", "docId": "inner-hits", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inner-hits.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-inner-hits", "name": "inner_hits", "required": false, "type": { @@ -85036,7 +85038,7 @@ { "kind": "interface", "extDocId": "query-dsl-has-parent-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-has-parent-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-has-parent-query", "inherits": { "type": { "name": "QueryBase", @@ -85064,7 +85066,7 @@ { "description": "If defined, each search hit will contain inner hits.", "docId": "inner-hits", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inner-hits.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-inner-hits", "name": "inner_hits", "required": false, "type": { @@ -85118,7 +85120,7 @@ { "kind": "interface", "extDocId": "query-dsl-ids-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-ids-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-ids-query", "inherits": { "type": { "name": "QueryBase", @@ -85461,7 +85463,7 @@ { "description": "Analyzer used to normalize the term.", "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "docUrl": "https://www.elastic.co/docs/manage-data/data-store/text-analysis", "name": "analyzer", "required": false, "type": { @@ -85548,7 +85550,7 @@ { "description": "Analyzer used to analyze terms in the query.", "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "docUrl": "https://www.elastic.co/docs/manage-data/data-store/text-analysis", "name": "analyzer", "required": false, "type": { @@ -85634,7 +85636,7 @@ { "description": "Analyzer used to analyze the `prefix`.", "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "docUrl": "https://www.elastic.co/docs/manage-data/data-store/text-analysis", "name": "analyzer", "required": false, "type": { @@ -85675,7 +85677,7 @@ { "kind": "interface", "extDocId": "query-dsl-intervals-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-intervals-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-intervals-query", "inherits": { "type": { "name": "QueryBase", @@ -85714,7 +85716,7 @@ { "description": "Matches terms that are similar to the provided term, within an edit distance defined by `fuzziness`.", "docId": "fuzziness", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/common-options#fuzziness", "name": "fuzzy", "required": false, "type": { @@ -85821,7 +85823,7 @@ ], "description": "Text that we want similar documents for or a lookup to a document's field for the text.", "docId": "document-input-parameters", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-mlt-query.html#_document_input_parameters", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-mlt-query#_document_input_parameters", "name": { "name": "Like", "namespace": "_types.query_dsl" @@ -85963,7 +85965,7 @@ { "kind": "interface", "extDocId": "query-dsl-match-all-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-all-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-all-query", "inherits": { "type": { "name": "QueryBase", @@ -85980,7 +85982,7 @@ { "kind": "interface", "extDocId": "query-dsl-match-bool-prefix-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-bool-prefix-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-bool-prefix-query", "inherits": { "type": { "name": "QueryBase", @@ -85995,7 +85997,7 @@ { "description": "Analyzer used to convert the text in the query value into tokens.", "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "docUrl": "https://www.elastic.co/docs/manage-data/data-store/text-analysis", "name": "analyzer", "required": false, "type": { @@ -86009,7 +86011,7 @@ { "description": "Maximum edit distance allowed for matching.\nCan be applied to the term subqueries constructed for all terms but the final term.", "docId": "fuzziness", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/common-options#fuzziness", "name": "fuzziness", "required": false, "type": { @@ -86023,7 +86025,7 @@ { "description": "Method used to rewrite the query.\nCan be applied to the term subqueries constructed for all terms but the final term.", "docId": "query-dsl-multi-term-rewrite", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-multi-term-rewrite", "name": "fuzzy_rewrite", "required": false, "type": { @@ -86063,7 +86065,7 @@ { "description": "Minimum number of clauses that must match for a document to be returned.\nApplied to the constructed bool query.", "docId": "query-dsl-minimum-should-match", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-minimum-should-match", "name": "minimum_should_match", "required": false, "type": { @@ -86119,7 +86121,7 @@ { "kind": "interface", "extDocId": "query-dsl-match-none-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-all-query.html#query-dsl-match-none-query", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-all-query#query-dsl-match-none-query", "inherits": { "type": { "name": "QueryBase", @@ -86136,7 +86138,7 @@ { "kind": "interface", "extDocId": "query-dsl-match-query-phrase-prefix", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query-phrase-prefix.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query-phrase-prefix", "inherits": { "type": { "name": "QueryBase", @@ -86151,7 +86153,7 @@ { "description": "Analyzer used to convert text in the query value into tokens.", "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "docUrl": "https://www.elastic.co/docs/manage-data/data-store/text-analysis", "name": "analyzer", "required": false, "type": { @@ -86220,7 +86222,7 @@ { "kind": "interface", "extDocId": "query-dsl-match-query-phrase", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query-phrase.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query-phrase", "inherits": { "type": { "name": "QueryBase", @@ -86235,7 +86237,7 @@ { "description": "Analyzer used to convert the text in the query value into tokens.", "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "docUrl": "https://www.elastic.co/docs/manage-data/data-store/text-analysis", "name": "analyzer", "required": false, "type": { @@ -86291,7 +86293,7 @@ { "kind": "interface", "extDocId": "query-dsl-match-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query", "inherits": { "type": { "name": "QueryBase", @@ -86306,7 +86308,7 @@ { "description": "Analyzer used to convert the text in the query value into tokens.", "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "docUrl": "https://www.elastic.co/docs/manage-data/data-store/text-analysis", "name": "analyzer", "required": false, "type": { @@ -86348,7 +86350,7 @@ { "description": "Maximum edit distance allowed for matching.", "docId": "fuzziness", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/common-options#fuzziness", "name": "fuzziness", "required": false, "type": { @@ -86362,7 +86364,7 @@ { "description": "Method used to rewrite the query.", "docId": "query-dsl-multi-term-rewrite", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-multi-term-rewrite", "name": "fuzzy_rewrite", "required": false, "type": { @@ -86415,7 +86417,7 @@ { "description": "Minimum number of clauses that must match for a document to be returned.", "docId": "query-dsl-minimum-should-match", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-minimum-should-match", "name": "minimum_should_match", "required": false, "type": { @@ -86503,7 +86505,7 @@ { "kind": "interface", "extDocId": "query-dsl-mlt-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-mlt-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-mlt-query", "inherits": { "type": { "name": "QueryBase", @@ -86518,7 +86520,7 @@ { "description": "The analyzer that is used to analyze the free form text.\nDefaults to the analyzer associated with the first field in fields.", "extDocId": "analysis", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "extDocUrl": "https://www.elastic.co/docs/manage-data/data-store/text-analysis", "name": "analyzer", "required": false, "type": { @@ -86664,7 +86666,7 @@ { "description": "After the disjunctive query has been formed, this parameter controls the number of terms that must match.", "docId": "query-dsl-minimum-should-match", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-minimum-should-match", "name": "minimum_should_match", "required": false, "type": { @@ -86780,7 +86782,7 @@ { "kind": "interface", "extDocId": "query-dsl-multi-match-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-match-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-multi-match-query", "inherits": { "type": { "name": "QueryBase", @@ -86795,7 +86797,7 @@ { "description": "Analyzer used to convert the text in the query value into tokens.", "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "docUrl": "https://www.elastic.co/docs/manage-data/data-store/text-analysis", "name": "analyzer", "required": false, "type": { @@ -86849,7 +86851,7 @@ { "description": "Maximum edit distance allowed for matching.", "docId": "fuzziness", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/common-options#fuzziness", "name": "fuzziness", "required": false, "type": { @@ -86863,7 +86865,7 @@ { "description": "Method used to rewrite the query.", "docId": "query-dsl-multi-term-rewrite", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-multi-term-rewrite", "name": "fuzzy_rewrite", "required": false, "type": { @@ -86916,7 +86918,7 @@ { "description": "Minimum number of clauses that must match for a document to be returned.", "docId": "query-dsl-minimum-should-match", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-minimum-should-match", "name": "minimum_should_match", "required": false, "type": { @@ -87049,7 +87051,7 @@ { "kind": "interface", "extDocId": "query-dsl-nested-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-nested-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-nested-query", "inherits": { "type": { "name": "QueryBase", @@ -87077,7 +87079,7 @@ { "description": "If defined, each search hit will contain inner hits.", "docId": "inner-hits", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inner-hits.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-inner-hits", "name": "inner_hits", "required": false, "type": { @@ -87211,7 +87213,7 @@ { "kind": "interface", "extDocId": "query-dsl-parent-id-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-parent-id-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-parent-id-query", "inherits": { "type": { "name": "QueryBase", @@ -87266,7 +87268,7 @@ { "kind": "interface", "extDocId": "query-dsl-percolate-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-percolate-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-percolate-query", "inherits": { "type": { "name": "QueryBase", @@ -87421,7 +87423,7 @@ { "kind": "interface", "extDocId": "query-dsl-pinned-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-pinned-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-pinned-query", "inherits": { "type": { "name": "QueryBase", @@ -87485,7 +87487,7 @@ { "kind": "interface", "extDocId": "query-dsl-prefix-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-prefix-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-prefix-query", "inherits": { "type": { "name": "QueryBase", @@ -87500,7 +87502,7 @@ { "description": "Method used to rewrite the query.", "docId": "query-dsl-multi-term-rewrite", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-multi-term-rewrite", "name": "rewrite", "required": false, "type": { @@ -87585,7 +87587,7 @@ "kind": "interface", "description": "An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.", "extDocId": "query-dsl", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl", "name": { "name": "QueryContainer", "namespace": "_types.query_dsl" @@ -87594,7 +87596,7 @@ { "description": "matches documents matching boolean combinations of other queries.", "extDocId": "query-dsl-bool-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-bool-query", "name": "bool", "required": false, "type": { @@ -87608,7 +87610,7 @@ { "description": "Returns documents matching a `positive` query while reducing the relevance score of documents that also match a `negative` query.", "extDocId": "query-dsl-boosting-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-boosting-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-boosting-query", "name": "boosting", "required": false, "type": { @@ -87654,7 +87656,7 @@ }, "description": "The `combined_fields` query supports searching multiple text fields as if their contents had been indexed into one combined field.", "extDocId": "query-dsl-combined-fields-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-combined-fields-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-combined-fields-query", "name": "combined_fields", "required": false, "type": { @@ -87668,7 +87670,7 @@ { "description": "Wraps a filter query and returns every matching document with a relevance score equal to the `boost` parameter value.", "extDocId": "query-dsl-constant-score-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-constant-score-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-constant-score-query", "name": "constant_score", "required": false, "type": { @@ -87682,7 +87684,7 @@ { "description": "Returns documents matching one or more wrapped queries, called query clauses or clauses.\nIf a returned document matches multiple query clauses, the `dis_max` query assigns the document the highest relevance score from any matching clause, plus a tie breaking increment for any additional matching subqueries.", "extDocId": "query-dsl-dis-max-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-dis-max-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-dis-max-query", "name": "dis_max", "required": false, "type": { @@ -87696,7 +87698,7 @@ { "description": "Boosts the relevance score of documents closer to a provided origin date or point.\nFor example, you can use this query to give more weight to documents closer to a certain date or location.", "extDocId": "query-dsl-distance-feature-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-distance-feature-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-distance-feature-query", "name": "distance_feature", "required": false, "type": { @@ -87710,7 +87712,7 @@ { "description": "Returns documents that contain an indexed value for a field.", "extDocId": "query-dsl-exists-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-exists-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-exists-query", "name": "exists", "required": false, "type": { @@ -87724,7 +87726,7 @@ { "description": "The `function_score` enables you to modify the score of documents that are retrieved by a query.", "extDocId": "query-dsl-function-score-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-function-score-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-function-score-query", "name": "function_score", "required": false, "type": { @@ -87738,7 +87740,7 @@ { "description": "Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance.", "extDocId": "query-dsl-fuzzy-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-fuzzy-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-fuzzy-query", "name": "fuzzy", "required": false, "type": { @@ -87763,7 +87765,7 @@ { "description": "Matches geo_point and geo_shape values that intersect a bounding box.", "extDocId": "query-dsl-geo-bounding-box-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-bounding-box-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-bounding-box-query", "name": "geo_bounding_box", "required": false, "type": { @@ -87777,7 +87779,7 @@ { "description": "Matches `geo_point` and `geo_shape` values within a given distance of a geopoint.", "extDocId": "query-dsl-geo-distance-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-distance-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-distance-query", "name": "geo_distance", "required": false, "type": { @@ -87829,7 +87831,7 @@ { "description": "Filter documents indexed using either the `geo_shape` or the `geo_point` type.", "extDocId": "query-dsl-geo-shape-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-shape-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-shape-query", "name": "geo_shape", "required": false, "type": { @@ -87843,7 +87845,7 @@ { "description": "Returns parent documents whose joined child documents match a provided query.", "extDocId": "query-dsl-has-child-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-has-child-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-has-child-query", "name": "has_child", "required": false, "type": { @@ -87857,7 +87859,7 @@ { "description": "Returns child documents whose joined parent document matches a provided query.", "extDocId": "query-dsl-has-parent-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-has-parent-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-has-parent-query", "name": "has_parent", "required": false, "type": { @@ -87871,7 +87873,7 @@ { "description": "Returns documents based on their IDs.\nThis query uses document IDs stored in the `_id` field.", "extDocId": "query-dsl-ids-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-ids-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-ids-query", "name": "ids", "required": false, "type": { @@ -87885,7 +87887,7 @@ { "description": "Returns documents based on the order and proximity of matching terms.", "extDocId": "query-dsl-intervals-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-intervals-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-intervals-query", "name": "intervals", "required": false, "type": { @@ -87910,7 +87912,7 @@ { "description": "Finds the k nearest vectors to a query vector, as measured by a similarity\nmetric. knn query finds nearest vectors through approximate search on indexed\ndense_vectors.", "extDocId": "query-dsl-knn-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-knn-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-knn-query", "name": "knn", "required": false, "type": { @@ -87924,7 +87926,7 @@ { "description": "Returns documents that match a provided text, number, date or boolean value.\nThe provided text is analyzed before matching.", "extDocId": "query-dsl-match-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query", "name": "match", "required": false, "type": { @@ -87949,7 +87951,7 @@ { "description": "Matches all documents, giving them all a `_score` of 1.0.", "extDocId": "query-dsl-match-all-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-all-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-all-query", "name": "match_all", "required": false, "type": { @@ -87963,7 +87965,7 @@ { "description": "Analyzes its input and constructs a `bool` query from the terms.\nEach term except the last is used in a `term` query.\nThe last term is used in a prefix query.", "extDocId": "query-dsl-match-bool-prefix-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-bool-prefix-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-bool-prefix-query", "name": "match_bool_prefix", "required": false, "type": { @@ -87988,7 +87990,7 @@ { "description": "Matches no documents.", "extDocId": "query-dsl-match-none-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-all-query.html#query-dsl-match-none-query", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-all-query#query-dsl-match-none-query", "name": "match_none", "required": false, "type": { @@ -88002,7 +88004,7 @@ { "description": "Analyzes the text and creates a phrase query out of the analyzed text.", "extDocId": "query-dsl-match-query-phrase", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query-phrase.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query-phrase", "name": "match_phrase", "required": false, "type": { @@ -88027,7 +88029,7 @@ { "description": "Returns documents that contain the words of a provided text, in the same order as provided.\nThe last term of the provided text is treated as a prefix, matching any words that begin with that term.", "extDocId": "query-dsl-match-query-phrase-prefix", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query-phrase-prefix.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query-phrase-prefix", "name": "match_phrase_prefix", "required": false, "type": { @@ -88052,7 +88054,7 @@ { "description": "Returns documents that are \"like\" a given set of documents.", "extDocId": "query-dsl-mlt-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-mlt-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-mlt-query", "name": "more_like_this", "required": false, "type": { @@ -88066,7 +88068,7 @@ { "description": "Enables you to search for a provided text, number, date or boolean value across multiple fields.\nThe provided text is analyzed before matching.", "extDocId": "query-dsl-multi-match-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-match-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-multi-match-query", "name": "multi_match", "required": false, "type": { @@ -88080,7 +88082,7 @@ { "description": "Wraps another query to search nested fields.\nIf an object matches the search, the nested query returns the root parent document.", "extDocId": "query-dsl-nested-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-nested-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-nested-query", "name": "nested", "required": false, "type": { @@ -88094,7 +88096,7 @@ { "description": "Returns child documents joined to a specific parent document.", "extDocId": "query-dsl-parent-id-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-parent-id-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-parent-id-query", "name": "parent_id", "required": false, "type": { @@ -88108,7 +88110,7 @@ { "description": "Matches queries stored in an index.", "extDocId": "query-dsl-percolate-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-percolate-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-percolate-query", "name": "percolate", "required": false, "type": { @@ -88122,7 +88124,7 @@ { "description": "Promotes selected documents to rank higher than those matching a given query.", "extDocId": "query-dsl-pinned-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-pinned-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-pinned-query", "name": "pinned", "required": false, "type": { @@ -88136,7 +88138,7 @@ { "description": "Returns documents that contain a specific prefix in a provided field.", "extDocId": "query-dsl-prefix-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-prefix-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-prefix-query", "name": "prefix", "required": false, "type": { @@ -88161,7 +88163,7 @@ { "description": "Returns documents based on a provided query string, using a parser with a strict syntax.", "extDocId": "query-dsl-query-string-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-query-string-query", "name": "query_string", "required": false, "type": { @@ -88175,7 +88177,7 @@ { "description": "Returns documents that contain terms within a provided range.", "extDocId": "query-dsl-range-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-range-query", "name": "range", "required": false, "type": { @@ -88200,7 +88202,7 @@ { "description": "Boosts the relevance score of documents based on the numeric value of a `rank_feature` or `rank_features` field.", "extDocId": "query-dsl-rank-feature-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-rank-feature-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-rank-feature-query", "name": "rank_feature", "required": false, "type": { @@ -88214,7 +88216,7 @@ { "description": "Returns documents that contain terms matching a regular expression.", "extDocId": "query-dsl-regexp-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-regexp-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-regexp-query", "name": "regexp", "required": false, "type": { @@ -88250,7 +88252,7 @@ { "description": "Filters documents based on a provided script.\nThe script query is typically used in a filter context.", "extDocId": "query-dsl-script-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-script-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-script-query", "name": "script", "required": false, "type": { @@ -88264,7 +88266,7 @@ { "description": "Uses a script to provide a custom score for returned documents.", "extDocId": "query-dsl-script-score-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-script-score-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-script-score-query", "name": "script_score", "required": false, "type": { @@ -88296,7 +88298,7 @@ { "description": "Queries documents that contain fields indexed using the `shape` type.", "extDocId": "query-dsl-shape-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-shape-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-shape-query", "name": "shape", "required": false, "type": { @@ -88310,7 +88312,7 @@ { "description": "Returns documents based on a provided query string, using a parser with a limited but fault-tolerant syntax.", "extDocId": "query-dsl-simple-query-string-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-simple-query-string-query", "name": "simple_query_string", "required": false, "type": { @@ -88324,7 +88326,7 @@ { "description": "Returns matches which enclose another span query.", "extDocId": "query-dsl-span-containing-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-containing-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-containing-query", "name": "span_containing", "required": false, "type": { @@ -88338,7 +88340,7 @@ { "description": "Wrapper to allow span queries to participate in composite single-field span queries by _lying_ about their search field.", "extDocId": "query-dsl-span-field-masking-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-field-masking-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-field-masking-query", "name": "span_field_masking", "required": false, "type": { @@ -88352,7 +88354,7 @@ { "description": "Matches spans near the beginning of a field.", "extDocId": "query-dsl-span-first-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-first-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-first-query", "name": "span_first", "required": false, "type": { @@ -88366,7 +88368,7 @@ { "description": "Allows you to wrap a multi term query (one of `wildcard`, `fuzzy`, `prefix`, `range`, or `regexp` query) as a `span` query, so it can be nested.", "extDocId": "query-dsl-span-multi-term-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-multi-term-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-multi-term-query", "name": "span_multi", "required": false, "type": { @@ -88380,7 +88382,7 @@ { "description": "Matches spans which are near one another.\nYou can specify `slop`, the maximum number of intervening unmatched positions, as well as whether matches are required to be in-order.", "extDocId": "query-dsl-span-near-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-near-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-near-query", "name": "span_near", "required": false, "type": { @@ -88394,7 +88396,7 @@ { "description": "Removes matches which overlap with another span query or which are within x tokens before (controlled by the parameter `pre`) or y tokens after (controlled by the parameter `post`) another span query.", "extDocId": "query-dsl-span-not-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-not-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-not-query", "name": "span_not", "required": false, "type": { @@ -88408,7 +88410,7 @@ { "description": "Matches the union of its span clauses.", "extDocId": "query-dsl-span-or-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-or-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-query", "name": "span_or", "required": false, "type": { @@ -88422,7 +88424,7 @@ { "description": "Matches spans containing a term.", "extDocId": "query-dsl-span-term-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-term-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-term-query", "name": "span_term", "required": false, "type": { @@ -88447,7 +88449,7 @@ { "description": "Returns matches which are enclosed inside another span query.", "extDocId": "query-dsl-span-within-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-within-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-within-query", "name": "span_within", "required": false, "type": { @@ -88467,7 +88469,7 @@ }, "description": "Using input query vectors or a natural language processing model to convert a query into a list of token-weight pairs, queries against a sparse vector field.", "extDocId": "query-dsl-sparse-vector-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-sparse-vector-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-sparse-vector-query", "name": "sparse_vector", "required": false, "type": { @@ -88481,7 +88483,7 @@ { "description": "Returns documents that contain an exact term in a provided field.\nTo return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.", "extDocId": "query-dsl-term-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-term-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-term-query", "name": "term", "required": false, "type": { @@ -88506,7 +88508,7 @@ { "description": "Returns documents that contain one or more exact terms in a provided field.\nTo return a document, one or more terms must exactly match a field value, including whitespace and capitalization.", "extDocId": "query-dsl-terms-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-terms-query", "name": "terms", "required": false, "type": { @@ -88520,7 +88522,7 @@ { "description": "Returns documents that contain a minimum number of exact terms in a provided field.\nTo return a document, a required number of terms must exactly match the field values, including whitespace and capitalization.", "extDocId": "query-dsl-terms-set-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-set-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-terms-set-query", "name": "terms_set", "required": false, "type": { @@ -88555,7 +88557,7 @@ }, "description": "Uses a natural language processing model to convert the query text into a list of token-weight pairs which are then used in a query against a sparse vector or rank features field.", "extDocId": "query-dsl-text-expansion-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-text-expansion-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-text-expansion-query", "name": "text_expansion", "required": false, "type": { @@ -88590,7 +88592,7 @@ }, "description": "Supports returning text_expansion query results by sending in precomputed tokens with the query.", "extDocId": "query-dsl-weighted-tokens-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-weighted-tokens-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-weighted-tokens-query", "name": "weighted_tokens", "required": false, "type": { @@ -88615,7 +88617,7 @@ { "description": "Returns documents that contain terms matching a wildcard pattern.", "extDocId": "query-dsl-wildcard-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-wildcard-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-wildcard-query", "name": "wildcard", "required": false, "type": { @@ -88640,7 +88642,7 @@ { "description": "A query that accepts any other query as base64 encoded string.", "extDocId": "query-dsl-wrapper-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-wrapper-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-wrapper-query", "name": "wrapper", "required": false, "type": { @@ -88676,7 +88678,7 @@ { "kind": "interface", "extDocId": "query-dsl-query-string-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-query-string-query", "inherits": { "type": { "name": "QueryBase", @@ -88704,7 +88706,7 @@ { "description": "Analyzer used to convert text in the query string into tokens.", "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "docUrl": "https://www.elastic.co/docs/manage-data/data-store/text-analysis", "name": "analyzer", "required": false, "type": { @@ -88809,7 +88811,7 @@ { "description": "Maximum edit distance allowed for fuzzy matching.", "docId": "fuzziness", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/common-options#fuzziness", "name": "fuzziness", "required": false, "type": { @@ -88849,7 +88851,7 @@ { "description": "Method used to rewrite the query.", "docId": "query-dsl-multi-term-rewrite", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-multi-term-rewrite", "name": "fuzzy_rewrite", "required": false, "type": { @@ -88902,7 +88904,7 @@ { "description": "Minimum number of clauses that must match for a document to be returned.", "docId": "query-dsl-minimum-should-match", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-minimum-should-match", "name": "minimum_should_match", "required": false, "type": { @@ -88965,7 +88967,7 @@ { "description": "Method used to rewrite the query.", "docId": "query-dsl-multi-term-rewrite", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-multi-term-rewrite", "name": "rewrite", "required": false, "type": { @@ -89069,7 +89071,7 @@ "term" ], "extDocId": "query-dsl-range-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-range-query", "name": { "name": "RangeQuery", "namespace": "_types.query_dsl" @@ -89398,7 +89400,7 @@ { "kind": "interface", "extDocId": "query-dsl-rank-feature-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-rank-feature-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-rank-feature-query", "inherits": { "type": { "name": "QueryBase", @@ -89476,7 +89478,7 @@ { "kind": "interface", "extDocId": "query-dsl-regexp-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-regexp-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-regexp-query", "inherits": { "type": { "name": "QueryBase", @@ -89510,7 +89512,7 @@ { "description": "Enables optional operators for the regular expression.", "docId": "regexp-syntax", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/regexp-syntax.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/regexp-syntax", "name": "flags", "required": false, "type": { @@ -89537,7 +89539,7 @@ { "description": "Method used to rewrite the query.", "docId": "query-dsl-multi-term-rewrite", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-multi-term-rewrite", "name": "rewrite", "required": false, "type": { @@ -89551,7 +89553,7 @@ { "description": "Regular expression for terms you wish to find in the provided field.", "docId": "regexp-syntax", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/regexp-syntax.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/regexp-syntax", "name": "value", "required": true, "type": { @@ -89569,7 +89571,7 @@ { "kind": "interface", "extDocId": "query-dsl-rule-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-rule-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-rule-query", "inherits": { "type": { "name": "QueryBase", @@ -89619,7 +89621,7 @@ { "kind": "interface", "extDocId": "query-dsl-script-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-script-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-script-query", "inherits": { "type": { "name": "QueryBase", @@ -89671,7 +89673,7 @@ { "kind": "interface", "extDocId": "query-dsl-script-score-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-script-score-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-script-score-query", "inherits": { "type": { "name": "QueryBase", @@ -89725,7 +89727,7 @@ { "kind": "interface", "extDocId": "query-dsl-semantic-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-semantic-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-semantic-query", "inherits": { "type": { "name": "QueryBase", @@ -89844,7 +89846,7 @@ } ], "extDocId": "query-dsl-shape-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-shape-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-shape-query", "inherits": { "type": { "name": "QueryBase", @@ -89937,7 +89939,7 @@ "kind": "type_alias", "description": "Query flags can be either a single flag or a combination of flags, e.g. `OR|AND|PREFIX`", "docId": "supported-flags", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html#supported-flags", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-simple-query-string-query#supported-flags", "name": { "name": "SimpleQueryStringFlags", "namespace": "_types.query_dsl" @@ -89963,7 +89965,7 @@ { "kind": "interface", "extDocId": "query-dsl-simple-query-string-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-simple-query-string-query", "inherits": { "type": { "name": "QueryBase", @@ -89978,7 +89980,7 @@ { "description": "Analyzer used to convert text in the query string into tokens.", "docId": "analysis", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html", + "docUrl": "https://www.elastic.co/docs/manage-data/data-store/text-analysis", "name": "analyzer", "required": false, "type": { @@ -90110,7 +90112,7 @@ { "description": "Minimum number of clauses that must match for a document to be returned.", "docId": "query-dsl-minimum-should-match", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-minimum-should-match", "name": "minimum_should_match", "required": false, "type": { @@ -90151,7 +90153,7 @@ { "kind": "interface", "extDocId": "query-dsl-span-containing-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-containing-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-containing-query", "inherits": { "type": { "name": "QueryBase", @@ -90193,7 +90195,7 @@ { "kind": "interface", "extDocId": "query-dsl-span-field-masking-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-field-masking-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-field-masking-query", "inherits": { "type": { "name": "QueryBase", @@ -90233,7 +90235,7 @@ { "kind": "interface", "extDocId": "query-dsl-span-first-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-first-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-first-query", "inherits": { "type": { "name": "QueryBase", @@ -90302,7 +90304,7 @@ { "kind": "interface", "extDocId": "query-dsl-span-multi-term-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-multi-term-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-multi-term-query", "inherits": { "type": { "name": "QueryBase", @@ -90332,7 +90334,7 @@ { "kind": "interface", "extDocId": "query-dsl-span-near-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-near-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-near-query", "inherits": { "type": { "name": "QueryBase", @@ -90389,7 +90391,7 @@ { "kind": "interface", "extDocId": "query-dsl-span-not-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-not-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-not-query", "inherits": { "type": { "name": "QueryBase", @@ -90469,7 +90471,7 @@ { "kind": "interface", "extDocId": "query-dsl-span-or-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-or-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-query", "inherits": { "type": { "name": "QueryBase", @@ -90646,7 +90648,7 @@ { "kind": "interface", "extDocId": "query-dsl-span-term-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-term-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-term-query", "inherits": { "type": { "name": "QueryBase", @@ -90679,7 +90681,7 @@ { "kind": "interface", "extDocId": "query-dsl-span-within-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-within-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-within-query", "inherits": { "type": { "name": "QueryBase", @@ -90721,7 +90723,7 @@ { "kind": "interface", "extDocId": "query-dsl-sparse-vector-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-sparse-vector-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-sparse-vector-query", "inherits": { "type": { "name": "QueryBase", @@ -90847,7 +90849,7 @@ { "kind": "interface", "extDocId": "query-dsl-term-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-term-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-term-query", "inherits": { "type": { "name": "QueryBase", @@ -91006,7 +91008,7 @@ } ], "extDocId": "query-dsl-terms-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-terms-query", "inherits": { "type": { "name": "QueryBase", @@ -91057,7 +91059,7 @@ { "kind": "interface", "extDocId": "query-dsl-terms-set-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-set-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-terms-set-query", "inherits": { "type": { "name": "QueryBase", @@ -91132,7 +91134,7 @@ { "kind": "interface", "extDocId": "query-dsl-text-expansion-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-text-expansion-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-text-expansion-query", "inherits": { "type": { "name": "QueryBase", @@ -91399,7 +91401,7 @@ { "kind": "interface", "extDocId": "query-dsl-weighted-tokens-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-weighted-tokens-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-weighted-tokens-query", "inherits": { "type": { "name": "QueryBase", @@ -91452,7 +91454,7 @@ { "kind": "interface", "extDocId": "query-dsl-wildcard-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-wildcard-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-wildcard-query", "inherits": { "type": { "name": "QueryBase", @@ -91485,7 +91487,7 @@ { "description": "Method used to rewrite the query.", "docId": "query-dsl-multi-term-rewrite", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-multi-term-rewrite", "name": "rewrite", "required": false, "type": { @@ -91527,7 +91529,7 @@ { "kind": "interface", "extDocId": "query-dsl-wrapper-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-wrapper-query.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-wrapper-query", "inherits": { "type": { "name": "QueryBase", @@ -92601,7 +92603,7 @@ }, { "docId": "sort-search-results", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results", "name": "sort", "required": false, "type": { @@ -93405,7 +93407,7 @@ { "description": "Decider settings.", "extDocId": "autoscaling-deciders", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-deciders.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/autoscaling/autoscaling-deciders", "name": "deciders", "required": true, "type": { @@ -110339,7 +110341,7 @@ { "description": "The remote cluster containing the leader indices to match against.", "docId": "modules-remote-clusters", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-remote-clusters.html", + "docUrl": "https://www.elastic.co/docs/deploy-manage/remote-clusters/remote-clusters-self-managed", "name": "remote_cluster", "required": true, "type": { @@ -111260,7 +111262,7 @@ }, { "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-meta-field", "name": "_meta", "required": false, "type": { @@ -111294,7 +111296,7 @@ "properties": [ { "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-meta-field", "name": "_meta", "required": false, "type": { @@ -114993,7 +114995,7 @@ { "kind": "interface", "docId": "modules-cluster", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-cluster.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/cluster-level-shard-allocation-routing-settings", "name": { "name": "CommandAllocateReplicaAction", "namespace": "cluster.reroute" @@ -115880,7 +115882,7 @@ { "description": "Contains statistics about the field data cache of selected nodes.", "docId": "modules-fielddata", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-fielddata.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/field-data-cache-settings", "name": "fielddata", "required": true, "type": { @@ -115954,7 +115956,7 @@ { "description": "Contains statistics about analyzers and analyzer components used in selected nodes.", "docId": "analyzer-anatomy", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analyzer-anatomy.html", + "docUrl": "https://www.elastic.co/docs/manage-data/data-store/text-analysis/anatomy-of-an-analyzer", "name": "versions", "required": false, "type": { @@ -116565,7 +116567,7 @@ { "description": "Contains statistics about the discovery types used by selected nodes.", "docId": "modules-discovery-hosts-providers", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-discovery-hosts-providers.html", + "docUrl": "https://www.elastic.co/docs/deploy-manage/distributed-architecture/discovery-cluster-formation/discovery-hosts-providers", "name": "discovery_types", "required": true, "type": { @@ -117990,7 +117992,7 @@ { "description": "Contains statistics about nodes selected by the request’s node filters.", "docId": "cluster-nodes", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cluster.html#cluster-nodes", "name": "nodes", "required": true, "type": { @@ -124081,7 +124083,7 @@ { "description": "Contains event sequences matching the query. Each object represents a matching sequence. This parameter is only returned for EQL queries containing a sequence.", "docId": "eql-sequences", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html#eql-sequences", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/eql/eql-syntax#eql-sequences", "name": "sequences", "required": false, "type": { @@ -124280,7 +124282,7 @@ { "description": "Set to `true` for events in a timespan-constrained sequence that do not meet a given condition.", "docId": "eql-missing-events", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html#eql-missing-events", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/eql/eql-syntax#eql-missing-events", "name": "missing", "required": false, "type": { @@ -124355,7 +124357,7 @@ { "description": "Shared field values used to constrain matches in the sequence. These are defined using the by keyword in the EQL query syntax.", "docId": "eql-sequences", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html#eql-sequences", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/eql/eql-syntax#eql-sequences", "name": "join_keys", "required": false, "type": { @@ -124674,7 +124676,7 @@ { "description": "EQL query you wish to run.", "docId": "eql-syntax", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/eql/eql-syntax", "name": "query", "required": true, "type": { @@ -124712,7 +124714,7 @@ { "description": "Field used to sort hits with the same timestamp in ascending order", "docId": "sort-tiebreaker", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql.html#eql-search-specify-a-sort-tiebreaker", + "docUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/eql#eql-search-specify-a-sort-tiebreaker", "name": "tiebreaker_field", "required": false, "type": { @@ -124837,7 +124839,7 @@ { "description": "For basic queries, the maximum number of matching events to return. Defaults to 10", "docId": "eql-basic-syntax", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html#eql-basic-syntax", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/eql/eql-syntax#eql-basic-syntax", "name": "size", "required": false, "type": { @@ -125873,7 +125875,7 @@ { "description": "To avoid any attempts of hacking or code injection, extract the values in a separate list of parameters. Use question mark placeholders (?) in the query string for each of the parameters.", "docId": "esql-query-params", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-rest.html#esql-rest-params", + "docUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/esql-rest#esql-rest-params", "name": "params", "required": false, "type": { @@ -126365,7 +126367,7 @@ { "description": "To avoid any attempts of hacking or code injection, extract the values in a separate list of parameters. Use question mark placeholders (?) in the query string for each of the parameters.", "docId": "esql-query-params", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-rest.html#esql-rest-params", + "docUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/esql-rest#esql-rest-params", "name": "params", "required": false, "type": { @@ -126944,7 +126946,7 @@ { "description": "If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests.", "docId": "ccs-network-delays", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-cross-cluster-search.html#ccs-network-delays", + "docUrl": "https://www.elastic.co/docs/solutions/search/cross-cluster-search#ccs-network-delays", "name": "ccs_minimize_roundtrips", "required": false, "serverDefault": true, @@ -127085,7 +127087,7 @@ } }, { - "description": "If true, returns partial results if there are shard request timeouts or [shard failures](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-replication.html#shard-failures). If false, returns\nan error with no partial results. Defaults to the configured cluster setting `search.default_allow_partial_results`\nwhich is true by default.", + "description": "If true, returns partial results if there are shard request timeouts or shard failures.\nIf false, returns an error with no partial results.\nDefaults to the configured cluster setting `search.default_allow_partial_results`, which is true by default.", "name": "allow_partial_search_results", "required": false, "type": { @@ -127426,7 +127428,7 @@ }, { "docId": "sort-search-results", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results", "name": "sort", "required": false, "type": { @@ -128117,7 +128119,7 @@ } }, { - "description": "If true, returns partial results if there are shard request timeouts or [shard failures](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-replication.html#shard-failures). If false, returns\nan error with no partial results. Defaults to the configured cluster setting `search.default_allow_partial_results`\nwhich is true by default.", + "description": "If true, returns partial results if there are shard request timeouts or shard failures.\nIf false, returns an error with no partial results.\nDefaults to the configured cluster setting `search.default_allow_partial_results`, which is true by default.", "name": "allow_partial_search_results", "required": false, "type": { @@ -128455,7 +128457,7 @@ { "description": "Filters associated terms so only those that are significantly associated with your query are included.", "docId": "search-aggregations-bucket-significantterms-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-significantterms-aggregation.html", + "docUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-significantterms-aggregation", "name": "use_significance", "required": true, "type": { @@ -131488,7 +131490,7 @@ { "description": "Custom metadata for the stream, copied from the `_meta` object of the stream’s matching index template.\nIf empty, the response omits this property.", "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-meta-field", "name": "_meta", "required": false, "type": { @@ -132745,7 +132747,7 @@ } ], "docId": "index-modules-settings", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#index-modules-settings", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/index-settings/index-modules", "name": { "name": "IndexSettings", "namespace": "indices._types" @@ -133999,7 +134001,7 @@ { "description": "Optional user metadata about the index template. May have any contents.\nThis map is not automatically generated by Elasticsearch.", "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-meta-field", "name": "_meta", "required": false, "type": { @@ -134324,7 +134326,7 @@ { "description": "The indexing slow log, similar in functionality to the search slow log. The log file name ends with `_index_indexing_slowlog.json`.\nLog and the thresholds are configured in the same way as the search slowlog.", "docId": "index-modules-slowlog-slowlog", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules-slowlog.html#index-slow-log", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/index-settings/slow-log#index-slow-log", "name": "index", "required": false, "type": { @@ -134364,7 +134366,7 @@ "kind": "interface", "description": "Mapping Limit Settings", "docId": "mapping-settings-limit", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-settings-limit.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/index-settings/mapping-limit", "name": { "name": "MappingLimitSettings", "namespace": "indices._types" @@ -136461,7 +136463,7 @@ { "description": "The name of the analyzer that should be applied to the provided `text`.\nThis could be a built-in analyzer, or an analyzer that’s been configured in the index.", "docId": "analysis-analyzers", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-analyzers.html", + "docUrl": "https://www.elastic.co/docs/reference/text-analysis/analyzer-reference", "name": "analyzer", "required": false, "type": { @@ -136490,7 +136492,7 @@ { "description": "Array of character filters used to preprocess characters before the tokenizer.", "docId": "analysis-charfilters", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-charfilters.html", + "docUrl": "https://www.elastic.co/docs/reference/text-analysis/character-filter-reference", "name": "char_filter", "required": false, "type": { @@ -136532,7 +136534,7 @@ { "description": "Array of token filters used to apply after the tokenizer.", "docId": "analysis-tokenfilters", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenfilters.html", + "docUrl": "https://www.elastic.co/docs/reference/text-analysis/token-filter-reference", "name": "filter", "required": false, "type": { @@ -136549,7 +136551,7 @@ { "description": "Normalizer to use to convert text into a single token.", "docId": "analysis-normalizers", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-normalizers.html", + "docUrl": "https://www.elastic.co/docs/reference/text-analysis/normalizers", "name": "normalizer", "required": false, "type": { @@ -136575,7 +136577,7 @@ { "description": "Tokenizer to use to convert text into tokens.", "docId": "analysis-tokenizers", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenizers.html", + "docUrl": "https://www.elastic.co/docs/reference/text-analysis/tokenizer-reference", "name": "tokenizer", "required": false, "type": { @@ -136640,7 +136642,7 @@ { "description": "Index used to derive the analyzer.\nIf specified, the `analyzer` or field parameter overrides this value.\nIf no index is specified or the index does not have a default analyzer, the analyze API uses the standard analyzer.", "docId": "analysis-standard-analyzer", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-standard-analyzer.html", + "docUrl": "https://www.elastic.co/docs/reference/text-analysis/analysis-standard-analyzer", "name": "index", "required": false, "type": { @@ -136656,7 +136658,7 @@ { "description": "Index used to derive the analyzer.\nIf specified, the `analyzer` or field parameter overrides this value.\nIf no index is specified or the index does not have a default analyzer, the analyze API uses the standard analyzer.", "docId": "analysis-standard-analyzer", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-standard-analyzer.html", + "docUrl": "https://www.elastic.co/docs/reference/text-analysis/analysis-standard-analyzer", "name": "index", "required": false, "type": { @@ -137023,7 +137025,7 @@ { "description": "Configuration options for the target index.", "docId": "index-modules-settings", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#index-modules-settings", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/index-settings/index-modules", "name": "settings", "required": false, "type": { @@ -137457,7 +137459,7 @@ { "description": "Mapping for fields in the index. If specified, this mapping can include:\n- Field names\n- Field data types\n- Mapping parameters", "docId": "mapping", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping.html", + "docUrl": "https://www.elastic.co/docs/manage-data/data-store/mapping", "name": "mappings", "required": false, "type": { @@ -142765,7 +142767,7 @@ { "description": "Alias to update.\nIf the alias doesn’t exist, the request creates it.\nIndex alias names support date math.", "docId": "api-date-math-index-names", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#api-date-math-index-names", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/api-conventions#api-date-math-index-names", "name": "name", "required": true, "type": { @@ -143140,7 +143142,7 @@ { "description": "Optional user metadata about the index template.\nIt may have any contents.\nIt is not automatically generated or used by Elasticsearch.\nThis user-defined object is stored in the cluster state, so keeping it short is preferable\nTo unset the metadata, replace the template without specifying it.", "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-meta-field", "name": "_meta", "required": false, "type": { @@ -147547,7 +147549,7 @@ { "description": "Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation.", "docId": "avoid-index-pattern-collisions", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index-templates.html#avoid-index-pattern-collisions", + "docUrl": "https://www.elastic.co/docs/manage-data/data-store/templates#avoid-index-pattern-collisions", "name": "index_patterns", "required": false, "type": { @@ -147624,7 +147626,7 @@ { "description": "Optional user metadata about the index template.\nMay have any contents.\nThis map is not automatically generated by Elasticsearch.", "docId": "mapping-meta-field", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-meta-field", "name": "_meta", "required": false, "type": { @@ -151673,7 +151675,7 @@ { "description": "The name of the model to use for the inference task.\nIt can be the ID of a built-in model (for example, `.multilingual-e5-small` for E5) or a text embedding model that was uploaded by using the Eland client.", "extDocId": "eland-import", - "extDocUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-nlp-import-model.html#ml-nlp-import-script", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/machine-learning/nlp/ml-nlp-import-model#ml-nlp-import-script", "name": "model_id", "required": true, "type": { @@ -154023,7 +154025,7 @@ { "description": "The chunking configuration object.", "extDocId": "inference-chunking", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config", "name": "chunking_settings", "required": false, "type": { @@ -154164,7 +154166,7 @@ { "description": "The chunking configuration object.", "extDocId": "inference-chunking", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config", "name": "chunking_settings", "required": false, "type": { @@ -154295,7 +154297,7 @@ { "description": "The chunking configuration object.", "extDocId": "inference-chunking", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config", "name": "chunking_settings", "required": false, "type": { @@ -154420,7 +154422,7 @@ { "description": "The chunking configuration object.", "extDocId": "inference-chunking", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config", "name": "chunking_settings", "required": false, "type": { @@ -154551,7 +154553,7 @@ { "description": "The chunking configuration object.", "extDocId": "inference-chunking", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config", "name": "chunking_settings", "required": false, "type": { @@ -154682,7 +154684,7 @@ { "description": "The chunking configuration object.", "extDocId": "inference-chunking", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config", "name": "chunking_settings", "required": false, "type": { @@ -154813,7 +154815,7 @@ { "description": "The chunking configuration object.", "extDocId": "inference-chunking", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config", "name": "chunking_settings", "required": false, "type": { @@ -154970,7 +154972,7 @@ { "description": "The chunking configuration object.", "extDocId": "inference-chunking", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config", "name": "chunking_settings", "required": false, "type": { @@ -155099,7 +155101,7 @@ { "description": "The chunking configuration object.", "extDocId": "inference-chunking", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config", "name": "chunking_settings", "required": false, "type": { @@ -155213,7 +155215,7 @@ { "description": "The chunking configuration object.", "extDocId": "inference-chunking", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config", "name": "chunking_settings", "required": false, "type": { @@ -155344,7 +155346,7 @@ { "description": "The chunking configuration object.", "extDocId": "inference-chunking", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config", "name": "chunking_settings", "required": false, "type": { @@ -155458,7 +155460,7 @@ { "description": "The chunking configuration object.", "extDocId": "inference-chunking", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config", "name": "chunking_settings", "required": false, "type": { @@ -155589,7 +155591,7 @@ { "description": "The chunking configuration object.", "extDocId": "inference-chunking", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config", "name": "chunking_settings", "required": false, "type": { @@ -155702,7 +155704,7 @@ { "description": "The chunking configuration object.", "extDocId": "inference-chunking", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config", "name": "chunking_settings", "required": false, "type": { @@ -155833,7 +155835,7 @@ { "description": "The chunking configuration object.", "extDocId": "inference-chunking", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config", "name": "chunking_settings", "required": false, "type": { @@ -160020,7 +160022,7 @@ { "description": "Appends one or more values to an existing array if the field already exists and it is an array.\nConverts a scalar to an array and appends one or more values to it if the field exists and it is a scalar.\nCreates an array containing the provided values if the field doesn’t exist.\nAccepts a single value or an array of values.", "docId": "append-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/append-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/append-processor", "name": "append", "required": false, "type": { @@ -160034,7 +160036,7 @@ { "description": "The attachment processor lets Elasticsearch extract file attachments in common formats (such as PPT, XLS, and PDF) by using the Apache text extraction library Tika.", "docId": "attachment", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/attachment.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/attachment", "name": "attachment", "required": false, "type": { @@ -160048,7 +160050,7 @@ { "description": "Converts a human readable byte value (for example `1kb`) to its value in bytes (for example `1024`).\nIf the field is an array of strings, all members of the array will be converted.\nSupported human readable units are \"b\", \"kb\", \"mb\", \"gb\", \"tb\", \"pb\" case insensitive.\nAn error will occur if the field is not a supported format or resultant value exceeds 2^63.", "docId": "bytes-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/bytes-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/bytes-processor", "name": "bytes", "required": false, "type": { @@ -160062,7 +160064,7 @@ { "description": "Converts circle definitions of shapes to regular polygons which approximate them.", "docId": "ingest-circle-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest-circle-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/ingest-circle-processor", "name": "circle", "required": false, "type": { @@ -160076,7 +160078,7 @@ { "description": "Computes the Community ID for network flow data as defined in the\nCommunity ID Specification. You can use a community ID to correlate network\nevents related to a single flow.", "docId": "community-id-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/community-id-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/community-id-processor", "name": "community_id", "required": false, "type": { @@ -160090,7 +160092,7 @@ { "description": "Converts a field in the currently ingested document to a different type, such as converting a string to an integer.\nIf the field value is an array, all members will be converted.", "docId": "convert-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/convert-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/convert-processor", "name": "convert", "required": false, "type": { @@ -160104,7 +160106,7 @@ { "description": "Extracts fields from CSV line out of a single text field within a document.\nAny empty field in CSV will be skipped.", "docId": "csv-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/csv-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/csv-processor", "name": "csv", "required": false, "type": { @@ -160118,7 +160120,7 @@ { "description": "Parses dates from fields, and then uses the date or timestamp as the timestamp for the document.", "docId": "data-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/date-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/date-processor", "name": "date", "required": false, "type": { @@ -160132,7 +160134,7 @@ { "description": "The purpose of this processor is to point documents to the right time based index based on a date or timestamp field in a document by using the date math index name support.", "docId": "date-index-name-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/date-index-name-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/date-index-name-processor", "name": "date_index_name", "required": false, "type": { @@ -160146,7 +160148,7 @@ { "description": "Extracts structured fields out of a single text field by matching the text field against a delimiter-based pattern.", "docId": "dissect-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/dissect-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/dissect-processor", "name": "dissect", "required": false, "type": { @@ -160160,7 +160162,7 @@ { "description": "Expands a field with dots into an object field.\nThis processor allows fields with dots in the name to be accessible by other processors in the pipeline.\nOtherwise these fields can’t be accessed by any processor.", "docId": "dot-expand-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/dot-expand-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/dot-expand-processor", "name": "dot_expander", "required": false, "type": { @@ -160174,7 +160176,7 @@ { "description": "Drops the document without raising any errors.\nThis is useful to prevent the document from getting indexed based on some condition.", "docId": "drop-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/drop-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/drop-processor", "name": "drop", "required": false, "type": { @@ -160188,7 +160190,7 @@ { "description": "The `enrich` processor can enrich documents with data from another index.", "docId": "enrich-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/enrich-processor", "name": "enrich", "required": false, "type": { @@ -160202,7 +160204,7 @@ { "description": "Raises an exception.\nThis is useful for when you expect a pipeline to fail and want to relay a specific message to the requester.", "docId": "fail-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/fail-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/fail-processor", "name": "fail", "required": false, "type": { @@ -160216,7 +160218,7 @@ { "description": "Computes a hash of the document’s content. You can use this hash for\ncontent fingerprinting.", "docId": "fingerprint-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/fingerprint-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/fingerprint-processor", "name": "fingerprint", "required": false, "type": { @@ -160230,7 +160232,7 @@ { "description": "Runs an ingest processor on each element of an array or object.", "docId": "foreach-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/foreach-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/foreach-processor", "name": "foreach", "required": false, "type": { @@ -160256,7 +160258,7 @@ { "description": "Converts geo-grid definitions of grid tiles or cells to regular bounding boxes or polygons which describe their shape.\nThis is useful if there is a need to interact with the tile shapes as spatially indexable fields.", "docId": "geo-grid-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest-geo-grid-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/ingest-geo-grid-processor", "name": "geo_grid", "required": false, "type": { @@ -160270,7 +160272,7 @@ { "description": "The `geoip` processor adds information about the geographical location of an IPv4 or IPv6 address.", "docId": "geoip-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/geoip-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/geoip-processor", "name": "geoip", "required": false, "type": { @@ -160284,7 +160286,7 @@ { "description": "Extracts structured fields out of a single text field within a document.\nYou choose which field to extract matched fields from, as well as the grok pattern you expect will match.\nA grok pattern is like a regular expression that supports aliased expressions that can be reused.", "docId": "grok-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/grok-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/grok-processor", "name": "grok", "required": false, "type": { @@ -160298,7 +160300,7 @@ { "description": "Converts a string field by applying a regular expression and a replacement.\nIf the field is an array of string, all members of the array will be converted.\nIf any non-string values are encountered, the processor will throw an exception.", "docId": "gsub-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/gsub-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/gsub-processor", "name": "gsub", "required": false, "type": { @@ -160325,7 +160327,7 @@ { "description": "Uses a pre-trained data frame analytics model or a model deployed for natural language processing tasks to infer against the data that is being ingested in the pipeline.", "docId": "inference-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/inference-processor", "name": "inference", "required": false, "type": { @@ -160339,7 +160341,7 @@ { "description": "Joins each element of an array into a single string using a separator character between each element.\nThrows an error when the field is not an array.", "docId": "join-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/join-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/join-processor", "name": "join", "required": false, "type": { @@ -160353,7 +160355,7 @@ { "description": "Converts a JSON string into a structured JSON object.", "docId": "json-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/json-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/json-processor", "name": "json", "required": false, "type": { @@ -160367,7 +160369,7 @@ { "description": "This processor helps automatically parse messages (or specific event fields) which are of the `foo=bar` variety.", "docId": "kv-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/kv-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/kv-processor", "name": "kv", "required": false, "type": { @@ -160381,7 +160383,7 @@ { "description": "Converts a string to its lowercase equivalent.\nIf the field is an array of strings, all members of the array will be converted.", "docId": "lowercase-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/lowercase-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/lowercase-processor", "name": "lowercase", "required": false, "type": { @@ -160395,7 +160397,7 @@ { "description": "Calculates the network direction given a source IP address, destination IP\naddress, and a list of internal networks.", "docId": "network-direction-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/network-direction-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/network-direction-processor", "name": "network_direction", "required": false, "type": { @@ -160409,7 +160411,7 @@ { "description": "Executes another pipeline.", "docId": "pipeline-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/pipeline-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/pipeline-processor", "name": "pipeline", "required": false, "type": { @@ -160423,7 +160425,7 @@ { "description": "The Redact processor uses the Grok rules engine to obscure text in the input document matching the given Grok patterns.\nThe processor can be used to obscure Personal Identifying Information (PII) by configuring it to detect known patterns such as email or IP addresses.\nText that matches a Grok pattern is replaced with a configurable string such as `` where an email address is matched or simply replace all matches with the text `` if preferred.", "docId": "redact-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/redact-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/redact-processor", "name": "redact", "required": false, "type": { @@ -160437,7 +160439,7 @@ { "description": "Extracts the registered domain (also known as the effective top-level\ndomain or eTLD), sub-domain, and top-level domain from a fully qualified\ndomain name (FQDN). Uses the registered domains defined in the Mozilla\nPublic Suffix List.", "docId": "registered-domain-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/registered-domain-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/registered-domain-processor", "name": "registered_domain", "required": false, "type": { @@ -160451,7 +160453,7 @@ { "description": "Removes existing fields.\nIf one field doesn’t exist, an exception will be thrown.", "docId": "remove-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/remove-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/remove-processor", "name": "remove", "required": false, "type": { @@ -160465,7 +160467,7 @@ { "description": "Renames an existing field.\nIf the field doesn’t exist or the new name is already used, an exception will be thrown.", "docId": "rename-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/rename-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/rename-processor", "name": "rename", "required": false, "type": { @@ -160479,7 +160481,7 @@ { "description": "Routes a document to another target index or data stream.\nWhen setting the `destination` option, the target is explicitly specified and the dataset and namespace options can’t be set.\nWhen the `destination` option is not set, this processor is in a data stream mode. Note that in this mode, the reroute processor can only be used on data streams that follow the data stream naming scheme.", "docId": "reroute-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/reroute-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/reroute-processor", "name": "reroute", "required": false, "type": { @@ -160493,7 +160495,7 @@ { "description": "Runs an inline or stored script on incoming documents.\nThe script runs in the `ingest` context.", "docId": "script-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/script-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/script-processor", "name": "script", "required": false, "type": { @@ -160507,7 +160509,7 @@ { "description": "Adds a field with the specified value.\nIf the field already exists, its value will be replaced with the provided one.", "docId": "set-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/set-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/set-processor", "name": "set", "required": false, "type": { @@ -160535,7 +160537,7 @@ { "description": "Sorts the elements of an array ascending or descending.\nHomogeneous arrays of numbers will be sorted numerically, while arrays of strings or heterogeneous arrays of strings + numbers will be sorted lexicographically.\nThrows an error when the field is not an array.", "docId": "sort-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/sort-processor", "name": "sort", "required": false, "type": { @@ -160549,7 +160551,7 @@ { "description": "Splits a field into an array using a separator character.\nOnly works on string fields.", "docId": "split-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/split-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/split-processor", "name": "split", "required": false, "type": { @@ -160563,7 +160565,7 @@ { "description": "Terminates the current ingest pipeline, causing no further processors to be run.\nThis will normally be executed conditionally, using the `if` option.", "docId": "terminate-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/terminate-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/terminate-processor", "name": "terminate", "required": false, "type": { @@ -160577,7 +160579,7 @@ { "description": "Trims whitespace from a field.\nIf the field is an array of strings, all members of the array will be trimmed.\nThis only works on leading and trailing whitespace.", "docId": "trim-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/trim-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/trim-processor", "name": "trim", "required": false, "type": { @@ -160591,7 +160593,7 @@ { "description": "Converts a string to its uppercase equivalent.\nIf the field is an array of strings, all members of the array will be converted.", "docId": "uppercase-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/uppercase-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/uppercase-processor", "name": "uppercase", "required": false, "type": { @@ -160605,7 +160607,7 @@ { "description": "URL-decodes a string.\nIf the field is an array of strings, all members of the array will be decoded.", "docId": "urldecode-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/urldecode-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/urldecode-processor", "name": "urldecode", "required": false, "type": { @@ -160632,7 +160634,7 @@ { "description": "The `user_agent` processor extracts details from the user agent string a browser sends with its web requests.\nThis processor adds this information by default under the `user_agent` field.", "docId": "user-agent-processor", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/user-agent-processor.html", + "docUrl": "https://www.elastic.co/docs/reference/enrich-processor/user-agent-processor", "name": "user_agent", "required": false, "type": { @@ -164437,7 +164439,7 @@ { "description": "The configuration for the pipeline.", "extDocId": "logstash-configuration-file-structure", - "extDocUrl": "https://www.elastic.co/guide/en/logstash/current/configuration-file-structure.html", + "extDocUrl": "https://www.elastic.co/docs/reference/logstash/configuration-file-structure", "name": "pipeline", "required": true, "type": { @@ -164463,7 +164465,7 @@ { "description": "Settings for the pipeline.\nIt supports only flat keys in dot notation.", "extDocId": "logstash-logstash-settings-file", - "extDocUrl": "https://www.elastic.co/guide/en/logstash/current/logstash-settings-file.html", + "extDocUrl": "https://www.elastic.co/docs/reference/logstash/logstash-settings-file", "name": "pipeline_settings", "required": true, "type": { @@ -164531,7 +164533,7 @@ { "description": "The number of workers that will, in parallel, execute the filter and output stages of the pipeline.", "docId": "logstash-logstash-settings-file", - "docUrl": "https://www.elastic.co/guide/en/logstash/current/logstash-settings-file.html", + "docUrl": "https://www.elastic.co/docs/reference/logstash/logstash-settings-file", "name": "pipeline.workers", "required": true, "type": { @@ -164569,7 +164571,7 @@ { "description": "The internal queuing model to use for event buffering.", "docId": "logstash-logstash-settings-file", - "docUrl": "https://www.elastic.co/guide/en/logstash/current/logstash-settings-file.html", + "docUrl": "https://www.elastic.co/docs/reference/logstash/logstash-settings-file", "name": "queue.type", "required": true, "type": { @@ -167028,7 +167030,7 @@ { "description": "The name or definition of the tokenizer to use after character filters are applied. This property is compulsory if `categorization_analyzer` is specified as an object. Machine learning provides a tokenizer called `ml_standard` that tokenizes in a way that has been determined to produce good categorization results on a variety of log file formats for logs in English. If you want to use that tokenizer but change the character or token filters, specify \"tokenizer\": \"ml_standard\" in your `categorization_analyzer`. Additionally, the `ml_classic` tokenizer is available, which tokenizes in the same way as the non-customizable tokenizer in old versions of the product (before 6.2). `ml_classic` was the default categorization tokenizer in versions 6.2 to 7.13, so if you need categorization identical to the default for jobs created in these versions, specify \"tokenizer\": \"ml_classic\" in your `categorization_analyzer`.", "extDocId": "analysis-tokenizers", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenizers.html", + "extDocUrl": "https://www.elastic.co/docs/reference/text-analysis/tokenizer-reference", "name": "tokenizer", "required": false, "type": { @@ -167315,7 +167317,7 @@ { "description": "Specifies the maximum number of feature importance values per document.", "docId": "ml-feature-importance", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-feature-importance.html", + "docUrl": "https://www.elastic.co/docs/explore-analyze/machine-learning/data-frame-analytics/ml-feature-importance", "name": "num_top_feature_importance_values", "required": false, "serverDefault": 0, @@ -167882,7 +167884,7 @@ }, { "extDocId": "query-dsl", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl", "name": "query", "required": true, "type": { @@ -168827,7 +168829,7 @@ { "description": "The configuration information necessary to perform classification.", "docId": "ml-classification", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-dfa-classification.html", + "docUrl": "https://www.elastic.co/docs/explore-analyze/machine-learning/data-frame-analytics/ml-dfa-classification", "name": "classification", "required": false, "type": { @@ -168841,7 +168843,7 @@ { "description": "The configuration information necessary to perform outlier detection. NOTE: Advanced parameters are for fine-tuning classification analysis. They are set automatically by hyperparameter optimization to give the minimum validation error. It is highly recommended to use the default values unless you fully understand the function of these parameters.", "docId": "ml-classification", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-dfa-classification.html", + "docUrl": "https://www.elastic.co/docs/explore-analyze/machine-learning/data-frame-analytics/ml-dfa-classification", "name": "outlier_detection", "required": false, "type": { @@ -168855,7 +168857,7 @@ { "description": "The configuration information necessary to perform regression. NOTE: Advanced parameters are for fine-tuning regression analysis. They are set automatically by hyperparameter optimization to give the minimum validation error. It is highly recommended to use the default values unless you fully understand the function of these parameters.", "docId": "ml-regression", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-dfa-regression.html", + "docUrl": "https://www.elastic.co/docs/explore-analyze/machine-learning/data-frame-analytics/ml-dfa-regression", "name": "regression", "required": false, "type": { @@ -169672,7 +169674,7 @@ { "description": "The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. By default, this property has the following value: {\"match_all\": {}}.", "docId": "query-dsl", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html", + "docUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl", "name": "query", "required": false, "type": { @@ -171116,7 +171118,7 @@ { "description": "The analysis function that is used.\nFor example, `count`, `rare`, `mean`, `min`, `max`, and `sum`.", "docId": "ml-functions", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-functions.html", + "docUrl": "https://www.elastic.co/docs/explore-analyze/machine-learning/anomaly-detection/ml-functions", "name": "function", "required": true, "type": { @@ -171809,7 +171811,7 @@ { "description": "A positive number showing how much the parameter influences the variation of the loss function. For hyperparameters with values that are not specified by the user but tuned during hyperparameter optimization.", "docId": "ml-regression-loss", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/dfa-regression-lossfunction.html", + "docUrl": "https://www.elastic.co/docs/explore-analyze/machine-learning/data-frame-analytics/dfa-regression-lossfunction", "name": "absolute_importance", "required": false, "type": { @@ -175317,7 +175319,7 @@ { "description": "Specifies the maximum number of feature importance values per document.", "docId": "ml-feature-importance", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-feature-importance.html", + "docUrl": "https://www.elastic.co/docs/explore-analyze/machine-learning/data-frame-analytics/ml-feature-importance", "name": "num_top_feature_importance_values", "required": false, "serverDefault": 0, @@ -177574,7 +177576,7 @@ { "description": "The number of times the model was loaded for inference and was not retrieved from the cache.\nIf this number is close to the `inference_count`, the cache is not being appropriately used.\nThis can be solved by increasing the cache size or its time-to-live (TTL).\nRefer to general machine learning settings for the appropriate settings.", "docId": "ml-settings", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/machine-learning-settings", "name": "cache_miss_count", "required": true, "type": { @@ -180175,7 +180177,7 @@ { "description": "A query clause that retrieves a subset of data from the source index.", "docId": "query-dsl", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html", + "docUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl", "name": "query", "required": false, "type": { @@ -180355,7 +180357,7 @@ { "description": "The approximate maximum amount of memory resources that are permitted for\nanalytical processing. If your `elasticsearch.yml` file contains an\n`xpack.ml.max_model_memory_limit` setting, an error occurs when you try to\ncreate data frame analytics jobs that have `model_memory_limit` values\ngreater than that setting.", "docId": "ml-settings", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/machine-learning-settings", "name": "model_memory_limit", "required": false, "serverDefault": "1gb", @@ -180395,7 +180397,7 @@ { "description": "Specifies whether this job can start when there is insufficient machine\nlearning node capacity for it to be immediately assigned to a node.", "docId": "ml-settings", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/machine-learning-settings", "name": "allow_lazy_start", "required": false, "serverDefault": false, @@ -185628,7 +185630,7 @@ { "description": "Specifies whether this job can start when there is insufficient machine\nlearning node capacity for it to be immediately assigned to a node. If\nset to `false` and a machine learning node with capacity to run the job\ncannot be immediately found, the API returns an error. If set to `true`,\nthe API does not return an error; the job waits in the `starting` state\nuntil sufficient machine learning node capacity is available. This\nbehavior is also affected by the cluster-wide\n`xpack.ml.max_lazy_ml_nodes` setting.", "docId": "ml-settings", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/machine-learning-settings", "name": "allow_lazy_start", "required": false, "serverDefault": false, @@ -189308,7 +189310,7 @@ { "description": "The approximate maximum amount of memory resources that are permitted for\nanalytical processing. If your `elasticsearch.yml` file contains an\n`xpack.ml.max_model_memory_limit` setting, an error occurs when you try\nto create data frame analytics jobs that have `model_memory_limit` values\ngreater than that setting.", "docId": "ml-settings", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/machine-learning-settings", "name": "model_memory_limit", "required": false, "serverDefault": "1gb", @@ -189336,7 +189338,7 @@ { "description": "Specifies whether this job can start when there is insufficient machine\nlearning node capacity for it to be immediately assigned to a node.", "docId": "ml-settings", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/machine-learning-settings", "name": "allow_lazy_start", "required": false, "serverDefault": false, @@ -190146,7 +190148,7 @@ { "description": "Advanced configuration option. Specifies whether this job can open when\nthere is insufficient machine learning node capacity for it to be\nimmediately assigned to a node. If `false` and a machine learning node\nwith capacity to run the job cannot immediately be found, the open\nanomaly detection jobs API returns an error. However, this is also\nsubject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this\noption is set to `true`, the open anomaly detection jobs API does not\nreturn an error and the job waits in the opening state until sufficient\nmachine learning node capacity is available.", "docId": "ml-settings", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/machine-learning-settings", "name": "allow_lazy_open", "required": false, "serverDefault": false, @@ -190252,7 +190254,7 @@ { "description": "Advanced configuration option, which affects the automatic removal of old\nmodel snapshots for this job. It specifies a period of time (in days)\nafter which only the first snapshot per day is retained. This period is\nrelative to the timestamp of the most recent snapshot for this job. Valid\nvalues range from 0 to `model_snapshot_retention_days`. For jobs created\nbefore version 7.8.0, the default value matches\n`model_snapshot_retention_days`.", "docId": "ml-model-snapshots", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-ad-run-jobs.html#ml-ad-model-snapshots", + "docUrl": "https://www.elastic.co/docs/explore-analyze/machine-learning/anomaly-detection/ml-ad-run-jobs#ml-ad-model-snapshots", "name": "daily_model_snapshot_retention_after_days", "required": false, "serverDefault": 1, @@ -190267,7 +190269,7 @@ { "description": "Advanced configuration option, which affects the automatic removal of old\nmodel snapshots for this job. It specifies the maximum period of time (in\ndays) that snapshots are retained. This period is relative to the\ntimestamp of the most recent snapshot for this job.", "docId": "ml-model-snapshots", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/current/ml-ad-run-jobs.html#ml-ad-model-snapshots", + "docUrl": "https://www.elastic.co/docs/explore-analyze/machine-learning/anomaly-detection/ml-ad-run-jobs#ml-ad-model-snapshots", "name": "model_snapshot_retention_days", "required": false, "serverDefault": 10, @@ -194203,7 +194205,7 @@ "codegenName": "node_stats", "description": "Contains statistics about the number of nodes selected by the request’s node filters.", "docId": "cluster-nodes", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cluster.html#cluster-nodes", "name": "_nodes", "required": false, "type": { @@ -196043,7 +196045,7 @@ { "description": "Comma-separated list of node IDs or names used to limit returned information.", "extDocId": "cluster-nodes", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cluster.html#cluster-nodes", "name": "node_id", "required": true, "type": { @@ -196105,7 +196107,7 @@ { "description": "Name of the cluster. Based on the `cluster.name` setting.", "extDocId": "cluster-name", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/important-settings.html#cluster-name", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/deploy/self-managed/important-settings-configuration##_cluster_name_setting", "name": "cluster_name", "required": true, "type": { @@ -196163,7 +196165,9 @@ }, "path": [ { - "description": "Comma-separated list of node IDs or names used to limit returned information.\nAll the nodes selective options are explained [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes).", + "description": "Comma-separated list of node IDs or names used to limit returned information.", + "extDocId": "cluster-nodes", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cluster.html#cluster-nodes", "name": "node_id", "required": true, "type": { @@ -196635,7 +196639,7 @@ { "description": "Total heap allowed to be used to hold recently indexed documents before they must be written to disk. This size is a shared pool across all shards on this node, and is controlled by Indexing Buffer settings.", "docId": "indexing-buffer", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/indexing-buffer.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/indexing-buffer-settings", "name": "total_indexing_buffer", "required": false, "type": { @@ -201244,7 +201248,7 @@ { "description": "The interval of time buckets to be generated when rolling up.", "docId": "calendar-and-fixed-intervals", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-datehistogram-aggregation.html#calendar_and_fixed_intervals", + "docUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-datehistogram-aggregation#calendar_and_fixed_intervals", "name": "calendar_interval", "required": false, "type": { @@ -201258,7 +201262,7 @@ { "description": "The interval of time buckets to be generated when rolling up.", "docId": "calendar-and-fixed-intervals", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-datehistogram-aggregation.html#calendar_and_fixed_intervals", + "docUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-datehistogram-aggregation#calendar_and_fixed_intervals", "name": "fixed_interval", "required": false, "type": { @@ -202604,7 +202608,7 @@ ], "description": "Specifies aggregations.", "extDocId": "rollup-agg-limitations", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-agg-limitations.html", + "extDocUrl": "https://www.elastic.co/docs/manage-data/lifecycle/rollup/rollup-aggregation-limitations", "name": "aggregations", "required": false, "type": { @@ -202629,7 +202633,7 @@ { "description": "Specifies a DSL query that is subject to some limitations.", "extDocId": "rollup-search-limitations", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-search-limitations.html", + "extDocUrl": "https://www.elastic.co/docs/manage-data/lifecycle/rollup/rollup-search-limitations", "name": "query", "required": false, "type": { @@ -205627,7 +205631,7 @@ { "description": "The document fields that the owners of the role have read access to.", "extDocId": "field-and-document-access-control", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/field-and-document-access-control.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level", "name": "field_security", "required": false, "type": { @@ -205894,7 +205898,7 @@ { "description": "The document fields that the owners of the role have read access to.", "extDocId": "field-and-document-access-control", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/field-and-document-access-control.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level", "name": "field_security", "required": false, "type": { @@ -205988,7 +205992,7 @@ { "description": "The document fields that the owners of the role have read access to.", "extDocId": "field-and-document-access-control", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/field-and-document-access-control.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level", "name": "field_security", "required": false, "type": { @@ -206317,7 +206321,7 @@ { "description": "A list of users that the API keys can impersonate.\nNOTE: In Elastic Cloud Serverless, the run-as feature is disabled.\nFor API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected.", "extDocId": "run-as-privilege", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/run-as-privilege.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/submitting-requests-on-behalf-of-other-users", "name": "run_as", "required": false, "type": { @@ -206536,7 +206540,7 @@ { "description": "A list of users that the API keys can impersonate.", "extDocId": "run-as-privilege", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/run-as-privilege.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/submitting-requests-on-behalf-of-other-users", "name": "run_as", "required": false, "type": { @@ -206565,7 +206569,7 @@ { "description": "A restriction for when the role descriptor is allowed to be effective.", "extDocId": "role-restriction", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/role-restriction.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/role-restriction", "name": "restriction", "required": false, "type": { @@ -206830,7 +206834,7 @@ { "description": "When you create a role, you can specify a query that defines the document level security permissions. You can optionally\nuse Mustache templates in the role query to insert the username of the current authenticated user into the role.\nLike other places in Elasticsearch that support templating or scripting, you can specify inline, stored, or file-based\ntemplates and define custom parameters. You access the details for the current authenticated user through the _user parameter.", "extDocId": "templating-role-query", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/field-and-document-access-control.html#templating-role-query", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level#templating-role-query", "name": "template", "required": false, "type": { @@ -206942,7 +206946,7 @@ { "description": "The document fields that the owners of the role have read access to.", "extDocId": "field-and-document-access-control", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/field-and-document-access-control.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level", "name": "field_security", "required": false, "type": { @@ -207172,7 +207176,7 @@ { "description": "The document fields that the owners of the role have read access to.", "extDocId": "field-and-document-access-control", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/field-and-document-access-control.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level", "name": "field_security", "required": false, "type": { @@ -214639,7 +214643,7 @@ { "description": "A list of users that the owners of this role can impersonate. *Note*: in Serverless, the run-as feature is disabled. For API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected.", "extDocId": "run-as-privilege", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/run-as-privilege.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/submitting-requests-on-behalf-of-other-users", "name": "run_as", "required": false, "type": { @@ -215088,7 +215092,7 @@ { "description": "A hash of the user's password.\nThis must be produced using the same hashing algorithm as has been configured for password storage.\nFor more details, see the explanation of the `xpack.security.authc.password_hashing.algorithm` setting in the user cache and password hash algorithm documentation.\nUsing this parameter allows the client to pre-hash the password for performance and/or confidentiality reasons.\nThe `password` parameter and the `password_hash` parameter cannot be used in the same request.", "extDocId": "security-settings-hashing", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-settings.html#hashing-settings", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/security-settings#hashing-settings", "name": "password_hash", "required": false, "type": { @@ -215365,7 +215369,7 @@ { "description": "A single-value metrics aggregation that calculates an approximate count of distinct values.", "docId": "search-aggregations-metrics-cardinality-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-cardinality-aggregation.html", + "docUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-cardinality-aggregation", "name": "cardinality", "required": false, "type": { @@ -215391,7 +215395,7 @@ { "description": "A multi-bucket value source based aggregation that enables the user to define a set of date ranges - each representing a bucket.", "docId": "search-aggregations-bucket-daterange-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-daterange-aggregation.html", + "docUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-daterange-aggregation", "name": "date_range", "required": false, "type": { @@ -215405,7 +215409,7 @@ { "description": "A single bucket aggregation that narrows the set of documents to those that match a query.", "docId": "search-aggregations-bucket-filter-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filter-aggregation.html", + "docUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-filter-aggregation", "name": "filter", "required": false, "type": { @@ -215419,7 +215423,7 @@ { "description": "A multi-bucket aggregation where each bucket contains the documents that match a query.", "docId": "search-aggregations-bucket-filters-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filters-aggregation.html", + "docUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-filters-aggregation", "name": "filters", "required": false, "type": { @@ -215444,7 +215448,7 @@ { "description": "A multi-bucket value source based aggregation that enables the user to define a set of ranges - each representing a bucket.", "docId": "search-aggregations-bucket-range-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-range-aggregation.html", + "docUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-range-aggregation", "name": "range", "required": false, "type": { @@ -215458,7 +215462,7 @@ { "description": "A multi-bucket value source based aggregation where buckets are dynamically built - one per unique value.", "docId": "search-aggregations-bucket-terms-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-terms-aggregation.html", + "docUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-terms-aggregation", "name": "terms", "required": false, "type": { @@ -215472,7 +215476,7 @@ { "description": "A single-value metrics aggregation that counts the number of values that are extracted from the aggregated documents.", "docId": "search-aggregations-metrics-valuecount-aggregation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-valuecount-aggregation.html", + "docUrl": "https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-valuecount-aggregation", "name": "value_count", "required": false, "type": { @@ -215575,7 +215579,7 @@ { "description": "Matches documents matching boolean combinations of other queries.", "docId": "query-dsl-bool-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-bool-query", "name": "bool", "required": false, "type": { @@ -215589,7 +215593,7 @@ { "description": "Returns documents that contain an indexed value for a field.", "docId": "query-dsl-exists-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-exists-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-exists-query", "name": "exists", "required": false, "type": { @@ -215603,7 +215607,7 @@ { "description": "Returns documents based on their IDs.\nThis query uses document IDs stored in the `_id` field.", "docId": "query-dsl-ids-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-ids-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-ids-query", "name": "ids", "required": false, "type": { @@ -215617,7 +215621,7 @@ { "description": "Returns documents that match a provided text, number, date or boolean value.\nThe provided text is analyzed before matching.", "docId": "query-dsl-match-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query", "name": "match", "required": false, "type": { @@ -215642,7 +215646,7 @@ { "description": "Matches all documents, giving them all a `_score` of 1.0.", "docId": "query-dsl-match-all-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-all-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-all-query", "name": "match_all", "required": false, "type": { @@ -215656,7 +215660,7 @@ { "description": "Returns documents that contain a specific prefix in a provided field.", "docId": "query-dsl-prefix-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-prefix-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-prefix-query", "name": "prefix", "required": false, "type": { @@ -215681,7 +215685,7 @@ { "description": "Returns documents that contain terms within a provided range.", "docId": "query-dsl-range-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-range-query", "name": "range", "required": false, "type": { @@ -215706,7 +215710,7 @@ { "description": "Returns documents based on a provided query string, using a parser with a limited but fault-tolerant syntax.", "docId": "query-dsl-simple-query-string-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-simple-query-string-query", "name": "simple_query_string", "required": false, "type": { @@ -215720,7 +215724,7 @@ { "description": "Returns documents that contain an exact term in a provided field.\nTo return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.", "docId": "query-dsl-term-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-term-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-term-query", "name": "term", "required": false, "type": { @@ -215745,7 +215749,7 @@ { "description": "Returns documents that contain one or more exact terms in a provided field.\nTo return a document, one or more terms must exactly match a field value, including whitespace and capitalization.", "docId": "query-dsl-terms-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-terms-query", "name": "terms", "required": false, "type": { @@ -215759,7 +215763,7 @@ { "description": "Returns documents that contain terms matching a wildcard pattern.", "docId": "query-dsl-wildcard-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-wildcard-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-wildcard-query", "name": "wildcard", "required": false, "type": { @@ -215850,7 +215854,7 @@ { "description": "The sort definition.\nOther than `id`, all public fields of an API key are eligible for sorting.\nIn addition, sort can also be applied to the `_doc` field to sort by index order.", "extDocId": "sort-search-results", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results", "name": "sort", "required": false, "type": { @@ -215877,7 +215881,7 @@ { "description": "The search after definition.", "extDocId": "search-after", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#search-after", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#search-after", "name": "search_after", "required": false, "type": { @@ -216146,7 +216150,7 @@ { "description": "The sort definition.\nYou can sort on `username`, `roles`, or `enabled`.\nIn addition, sort can also be applied to the `_doc` field to sort by index order.", "docId": "sort-search-results", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results", "name": "sort", "required": false, "type": { @@ -216173,7 +216177,7 @@ { "description": "The search after definition.", "extDocId": "search-after", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#search-after", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#search-after", "name": "search_after", "required": false, "type": { @@ -216287,7 +216291,7 @@ { "description": "matches roles matching boolean combinations of other queries.", "docId": "query-dsl-bool-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-bool-query", "name": "bool", "required": false, "type": { @@ -216301,7 +216305,7 @@ { "description": "Returns roles that contain an indexed value for a field.", "docId": "query-dsl-exists-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-exists-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-exists-query", "name": "exists", "required": false, "type": { @@ -216315,7 +216319,7 @@ { "description": "Returns roles based on their IDs.\nThis query uses role document IDs stored in the `_id` field.", "docId": "query-dsl-ids-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-ids-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-ids-query", "name": "ids", "required": false, "type": { @@ -216329,7 +216333,7 @@ { "description": "Returns roles that match a provided text, number, date or boolean value.\nThe provided text is analyzed before matching.", "docId": "query-dsl-match-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query", "name": "match", "required": false, "type": { @@ -216354,7 +216358,7 @@ { "description": "Matches all roles, giving them all a `_score` of 1.0.", "docId": "query-dsl-match-all-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-all-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-all-query", "name": "match_all", "required": false, "type": { @@ -216368,7 +216372,7 @@ { "description": "Returns roles that contain a specific prefix in a provided field.", "docId": "query-dsl-prefix-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-prefix-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-prefix-query", "name": "prefix", "required": false, "type": { @@ -216393,7 +216397,7 @@ { "description": "Returns roles that contain terms within a provided range.", "docId": "query-dsl-range-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-range-query", "name": "range", "required": false, "type": { @@ -216418,7 +216422,7 @@ { "description": "Returns roles based on a provided query string, using a parser with a limited but fault-tolerant syntax.", "docId": "query-dsl-simple-query-string-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-simple-query-string-query", "name": "simple_query_string", "required": false, "type": { @@ -216432,7 +216436,7 @@ { "description": "Returns roles that contain an exact term in a provided field.\nTo return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.", "docId": "query-dsl-term-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-term-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-term-query", "name": "term", "required": false, "type": { @@ -216457,7 +216461,7 @@ { "description": "Returns roles that contain one or more exact terms in a provided field.\nTo return a document, one or more terms must exactly match a field value, including whitespace and capitalization.", "docId": "query-dsl-terms-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-terms-query", "name": "terms", "required": false, "type": { @@ -216471,7 +216475,7 @@ { "description": "Returns roles that contain terms matching a wildcard pattern.", "docId": "query-dsl-wildcard-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-wildcard-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-wildcard-query", "name": "wildcard", "required": false, "type": { @@ -216563,7 +216567,7 @@ { "description": "The sort definition.\nFields eligible for sorting are: `username`, `roles`, `enabled`.\nIn addition, sort can also be applied to the `_doc` field to sort by index order.", "extDocId": "sort-search-results", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results", "name": "sort", "required": false, "type": { @@ -216590,7 +216594,7 @@ { "description": "The search after definition", "extDocId": "search-after", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#search-after", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#search-after", "name": "search_after", "required": false, "type": { @@ -216723,7 +216727,7 @@ { "description": "Returns users based on their IDs.\nThis query uses the user document IDs stored in the `_id` field.", "docId": "query-dsl-ids-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-ids-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-ids-query", "name": "ids", "required": false, "type": { @@ -216737,7 +216741,7 @@ { "description": "matches users matching boolean combinations of other queries.", "docId": "query-dsl-bool-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-bool-query", "name": "bool", "required": false, "type": { @@ -216751,7 +216755,7 @@ { "description": "Returns users that contain an indexed value for a field.", "docId": "query-dsl-exists-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-exists-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-exists-query", "name": "exists", "required": false, "type": { @@ -216765,7 +216769,7 @@ { "description": "Returns users that match a provided text, number, date or boolean value.\nThe provided text is analyzed before matching.", "docId": "query-dsl-match-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query", "name": "match", "required": false, "type": { @@ -216790,7 +216794,7 @@ { "description": "Matches all users, giving them all a `_score` of 1.0.", "docId": "query-dsl-match-all-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-all-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-all-query", "name": "match_all", "required": false, "type": { @@ -216804,7 +216808,7 @@ { "description": "Returns users that contain a specific prefix in a provided field.", "docId": "query-dsl-prefix-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-prefix-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-prefix-query", "name": "prefix", "required": false, "type": { @@ -216829,7 +216833,7 @@ { "description": "Returns users that contain terms within a provided range.", "docId": "query-dsl-range-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-range-query", "name": "range", "required": false, "type": { @@ -216854,7 +216858,7 @@ { "description": "Returns users based on a provided query string, using a parser with a limited but fault-tolerant syntax.", "docId": "query-dsl-simple-query-string-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-simple-query-string-query", "name": "simple_query_string", "required": false, "type": { @@ -216868,7 +216872,7 @@ { "description": "Returns users that contain an exact term in a provided field.\nTo return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.", "docId": "query-dsl-term-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-term-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-term-query", "name": "term", "required": false, "type": { @@ -216893,7 +216897,7 @@ { "description": "Returns users that contain one or more exact terms in a provided field.\nTo return a document, one or more terms must exactly match a field value, including whitespace and capitalization.", "docId": "query-dsl-terms-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-terms-query", "name": "terms", "required": false, "type": { @@ -216907,7 +216911,7 @@ { "description": "Returns users that contain terms matching a wildcard pattern.", "docId": "query-dsl-wildcard-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-wildcard-query.html", + "docUrl": "https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-wildcard-query", "name": "wildcard", "required": false, "type": { @@ -220793,7 +220797,7 @@ { "description": "The Azure repository type.", "extDocId": "repository-azure", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/repository-azure.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/azure-repository", "name": "type", "required": true, "type": { @@ -220970,7 +220974,7 @@ { "description": "The Google Cloud Storage repository type.", "extDocId": "repository-gcs", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/repository-gcs.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/google-cloud-storage-repository", "name": "type", "required": true, "type": { @@ -221177,7 +221181,7 @@ { "description": "The read-only URL repository type.", "extDocId": "repository-read-only", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-read-only-repository.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/read-only-url-repository", "name": "type", "required": true, "type": { @@ -221423,7 +221427,7 @@ { "description": "The S3 repository type.", "extDocId": "repository-s3", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/repository-s3.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/s3-repository", "name": "type", "required": true, "type": { @@ -221610,7 +221614,7 @@ { "description": "The S3 storage class for objects written to the repository.\nValues may be `standard`, `reduced_redundancy`, `standard_ia`, `onezone_ia`, and `intelligent_tiering`.", "extDocId": "repository-s3-storage-classes", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/repository-s3.html#repository-s3-storage-classes", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/s3-repository#repository-s3-storage-classes", "name": "storage_class", "required": false, "serverDefault": "standard", @@ -221906,7 +221910,7 @@ { "description": "The shared file system repository type.", "extDocId": "repository-shared-fs", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-filesystem-repository.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/shared-file-system-repository", "name": "type", "required": true, "type": { @@ -222600,7 +222604,7 @@ { "description": "The source-only repository type.", "extDocId": "repository-source-only", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-source-only-repository.html", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/source-only-repository", "name": "type", "required": true, "type": { @@ -223062,7 +223066,7 @@ { "description": "The feature states to include in the snapshot.\nEach feature state includes one or more system indices containing related data.\nYou can view a list of eligible features using the get features API.\n\nIf `include_global_state` is `true`, all current feature states are included by default.\nIf `include_global_state` is `false`, no feature states are included by default.\n\nNote that specifying an empty array will result in the default behavior.\nTo exclude all feature states, regardless of the `include_global_state` value, specify an array with only the value `none` (`[\"none\"]`).", "extDocId": "snapshot-restore-feature-state", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshot-restore.html#feature-state", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore#feature-state", "name": "feature_states", "required": false, "type": { @@ -225444,7 +225448,7 @@ { "description": "The feature states to restore.\nIf `include_global_state` is `true`, the request restores all feature states in the snapshot by default.\nIf `include_global_state` is `false`, the request restores no feature states by default.\nNote that specifying an empty array will result in the default behavior.\nTo restore no feature states, regardless of the `include_global_state` value, specify an array containing only the value `none` (`[\"none\"]`).", "extDocId": "snapshot-restore-feature-state", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshot-restore.html#feature-state", + "extDocUrl": "https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore#feature-state", "name": "feature_states", "required": false, "type": { @@ -226487,7 +226491,7 @@ { "description": "If `true`, the results are in a columnar fashion: one row represents all the values of a certain column from the current page of results.\nThe API supports this parameter only for CBOR, JSON, SMILE, and YAML responses.", "extDocId": "sql-rest-columnar", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-rest-columnar.html", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/sql-rest-columnar", "name": "columnar", "required": false, "serverDefault": false, @@ -226540,7 +226544,7 @@ { "description": "The Elasticsearch query DSL for additional filtering.", "extDocId": "sql-rest-filtering", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-rest-filtering.html", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/sql-rest-filtering", "name": "filter", "required": false, "serverDefault": "none", @@ -226626,7 +226630,7 @@ { "description": "The SQL query to run.", "extDocId": "sql-spec", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-spec.html", + "extDocUrl": "https://www.elastic.co/docs/reference/query-languages/sql/sql-spec", "name": "query", "required": false, "type": { @@ -226713,7 +226717,7 @@ { "description": "The format for the response.\nYou can also specify a format using the `Accept` HTTP header.\nIf you specify both this parameter and the `Accept` HTTP header, this parameter takes precedence.", "extDocId": "sql-rest-format", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-rest-format.html", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/sql-rest-format", "name": "format", "required": false, "type": { @@ -226873,7 +226877,7 @@ { "description": "The Elasticsearch query DSL for additional filtering.", "extDocId": "sql-rest-filtering", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-rest-filtering.html", + "extDocUrl": "https://www.elastic.co/docs/explore-analyze/query-filter/languages/sql-rest-filtering", "name": "filter", "required": false, "serverDefault": "none", @@ -227222,7 +227226,7 @@ { "description": "The synonyms that conform the synonym rule in Solr format.", "extDocId": "synonym-set-define", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-synonym-graph-tokenfilter.html#analysis-synonym-graph-define-synonyms", + "extDocUrl": "https://www.elastic.co/docs/reference/text-analysis/analysis-synonym-graph-tokenfilter#analysis-synonym-graph-define-synonyms", "name": "synonyms", "required": true, "type": { @@ -227276,9 +227280,9 @@ } }, { - "description": "Synonyms, in Solr format, that conform the synonym rule. See https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-synonym-graph-tokenfilter.html#_solr_synonyms_2", - "extDocId": "synonym-set-define", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-synonym-graph-tokenfilter.html#analysis-synonym-graph-define-synonyms", + "description": "Synonyms, in Solr format, that conform the synonym rule.", + "extDocId": "synonym-solr", + "extDocUrl": "https://www.elastic.co/docs/reference/text-analysis/analysis-synonym-graph-tokenfilter#_solr_format_2", "name": "synonyms", "required": true, "type": { @@ -227290,7 +227294,7 @@ } } ], - "specLocation": "synonyms/_types/SynonymRule.ts#L40-L49" + "specLocation": "synonyms/_types/SynonymRule.ts#L40-L50" }, { "kind": "type_alias", @@ -227892,7 +227896,7 @@ { "description": "The synonym rule information definition, which must be in Solr format.", "extDocId": "synonym-set-define", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-synonym-graph-tokenfilter.html#analysis-synonym-graph-define-synonyms", + "extDocUrl": "https://www.elastic.co/docs/reference/text-analysis/analysis-synonym-graph-tokenfilter#analysis-synonym-graph-define-synonyms", "name": "synonyms", "required": true, "type": { @@ -234271,7 +234275,7 @@ { "kind": "type_alias", "docId": "cron-expressions", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#api-cron-expressions", + "docUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/api-conventions#api-cron-expressions", "name": { "name": "CronExpression", "namespace": "watcher._types" @@ -239120,7 +239124,7 @@ { "description": "One or more fields used to sort the search results.", "extDocId": "sort-search-results", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results", "name": "sort", "required": false, "type": { @@ -239134,7 +239138,7 @@ { "description": "Retrieve the next page of hits using a set of sort values from the previous page.", "extDocId": "search-after", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#search-after", + "extDocUrl": "https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#search-after", "name": "search_after", "required": false, "type": { diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv index 3c70811697..2c805f43de 100644 --- a/specification/_doc_ids/table.csv +++ b/specification/_doc_ids/table.csv @@ -1,33 +1,33 @@ apis,https://www.elastic.co/docs/api/doc/elasticsearch -add-nodes,https://www.elastic.co/guide/en/elasticsearch/reference/current/add-elasticsearch-nodes.html +add-nodes,https://www.elastic.co/docs/deploy-manage/maintenance/add-and-remove-elasticsearch-nodes alias-update,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-alias aliases-update,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-update-aliases alibabacloud-api-keys,https://opensearch.console.aliyun.com/cn-shanghai/rag/api-key -analysis-analyzers,https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-analyzers.html +analysis-analyzers,https://www.elastic.co/docs/reference/text-analysis/analyzer-reference amazonbedrock-models,https://docs.aws.amazon.com/bedrock/latest/userguide/models-supported.html amazonbedrock-secret-keys,https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html -analysis-charfilters,https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-charfilters.html -analysis-normalizers,https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-normalizers.html -analysis-standard-analyzer,https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-standard-analyzer.html -analysis-tokenfilters,https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenfilters.html -analysis-tokenizers,https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenizers.html -analysis,https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html +analysis-charfilters,https://www.elastic.co/docs/reference/text-analysis/character-filter-reference +analysis-normalizers,https://www.elastic.co/docs/reference/text-analysis/normalizers +analysis-standard-analyzer,https://www.elastic.co/docs/reference/text-analysis/analysis-standard-analyzer +analysis-tokenfilters,https://www.elastic.co/docs/reference/text-analysis/token-filter-reference +analysis-tokenizers,https://www.elastic.co/docs/reference/text-analysis/tokenizer-reference +analysis,https://www.elastic.co/docs/manage-data/data-store/text-analysis analyze-repository,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-repository-analyze -analyzer-anatomy,https://www.elastic.co/guide/en/elasticsearch/reference/current/analyzer-anatomy.html +analyzer-anatomy,https://www.elastic.co/docs/manage-data/data-store/text-analysis/anatomy-of-an-analyzer anthropic-messages,https://docs.anthropic.com/en/api/messages anthropic-models,https://docs.anthropic.com/en/docs/about-claude/models/all-models#model-names -api-date-math-index-names,https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#api-date-math-index-names +api-date-math-index-names,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/api-conventions#api-date-math-index-names api-root,https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-info -append-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/append-processor.html +append-processor,https://www.elastic.co/docs/reference/enrich-processor/append-processor async-search,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit -attachment,https://www.elastic.co/guide/en/elasticsearch/reference/current/attachment.html -autoscaling,https://www.elastic.co/guide/en/cloud/current/ec-autoscaling.html -autoscaling-deciders,https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-deciders.html +attachment,https://www.elastic.co/docs/reference/enrich-processor/attachment +autoscaling,https://www.elastic.co/docs/deploy-manage/autoscaling +autoscaling-deciders,https://www.elastic.co/docs/deploy-manage/autoscaling/autoscaling-deciders autoscaling-delete-autoscaling-policy,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-delete-autoscaling-policy autoscaling-get-autoscaling-capacity,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-get-autoscaling-capacity autoscaling-get-autoscaling-policy,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-get-autoscaling-policy autoscaling-put-autoscaling-policy,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-put-autoscaling-policy -avoid-index-pattern-collisions,https://www.elastic.co/guide/en/elasticsearch/reference/current/index-templates.html#avoid-index-pattern-collisions +avoid-index-pattern-collisions,https://www.elastic.co/docs/manage-data/data-store/templates#avoid-index-pattern-collisions azureaistudio-api-keys,https://ai.azure.com/ azureaistudio-endpoint-types,https://learn.microsoft.com/en-us/azure/ai-foundry/concepts/deployments-overview#billing-for-deploying-and-inferencing-llms-in-azure-ai-studio azureopenai,https://oai.azure.com/ @@ -35,10 +35,10 @@ azureopenai-auth,https://learn.microsoft.com/en-us/azure/ai-services/openai/refe azureopenai-portal,https://portal.azure.com/#view/HubsExtension/BrowseAll azureopenai-quota-limits,https://learn.microsoft.com/en-us/azure/ai-services/openai/quotas-limits behavioral-analytics-collection-event,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-post-behavioral-analytics-event -behavioral-analytics-event-reference,https://www.elastic.co/guide/en/elasticsearch/reference/current/behavioral-analytics-event-reference.html -byte-units,https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#byte-units -bytes-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/bytes-processor.html -calendar-and-fixed-intervals,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-datehistogram-aggregation.html#calendar_and_fixed_intervals +behavioral-analytics-event-reference,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/behavioral-analytics-event-reference.html +byte-units,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/api-conventions#byte-units +bytes-processor,https://www.elastic.co/docs/reference/enrich-processor/bytes-processor +calendar-and-fixed-intervals,https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-datehistogram-aggregation#calendar_and_fixed_intervals cat-alias,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-aliases cat-allocation,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-allocation cat-anomaly-detectors,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-jobs @@ -65,8 +65,8 @@ cat-thread-pool,https://www.elastic.co/docs/api/doc/elasticsearch/operation/oper cat-trained-model,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-trained-models cat-transforms,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-transforms cat,https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-cat -ccr,https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-ccr.html -ccr-auto-follow,https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-auto-follow.html +ccr,https://www.elastic.co/docs/deploy-manage/tools/cross-cluster-replication +ccr-auto-follow,https://www.elastic.co/docs/deploy-manage/tools/cross-cluster-replication/manage-auto-follow-patterns ccr-delete-auto-follow-pattern,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-delete-auto-follow-pattern ccr-get-auto-follow-pattern,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-get-auto-follow-pattern-1 ccr-get-follow-info,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-follow-info @@ -80,9 +80,9 @@ ccr-post-unfollow,https://www.elastic.co/docs/api/doc/elasticsearch/operation/op ccr-put-auto-follow-pattern,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-put-auto-follow-pattern ccr-put-follow,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-follow ccr-resume-auto-follow-pattern,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-resume-auto-follow-pattern -ccs-network-delays,https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-cross-cluster-search.html#ccs-network-delays -ccs-privileges,https://www.elastic.co/guide/en/elasticsearch/reference/current/remote-clusters-cert.html#remote-clusters-privileges-ccs -clean-up-snapshot-repo,https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-register-repository.html#snapshots-repository-cleanup +ccs-network-delays,https://www.elastic.co/docs/solutions/search/cross-cluster-search#ccs-network-delays +ccs-privileges,https://www.elastic.co/docs/deploy-manage/remote-clusters/remote-clusters-cert#remote-clusters-privileges-ccs +clean-up-snapshot-repo,https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/self-managed#snapshots-repository-cleanup clear-repositories-metering-archive-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-clear-repositories-metering-archive clear-scroll-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-clear-scroll clear-trained-model,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-clear-trained-model-deployment-cache @@ -90,13 +90,13 @@ cluster-allocation-explain,https://www.elastic.co/docs/api/doc/elasticsearch/ope cluster-get-settings,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-get-settings cluster-health,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-health cluster-info,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-info -cluster-name,https://www.elastic.co/guide/en/elasticsearch/reference/current/important-settings.html#cluster-name +cluster-name,https://www.elastic.co/docs/deploy-manage/deploy/self-managed/important-settings-configuration##_cluster_name_setting cluster-nodes-hot-threads,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-hot-threads cluster-nodes-info,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-info cluster-nodes-reload-secure-settings,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-reload-secure-settings cluster-nodes-stats,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-stats cluster-nodes-usage,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-usage -cluster-nodes,https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes +cluster-nodes,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/cluster.html#cluster-nodes cluster-pending,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-pending-tasks cluster-ping,https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-cluster cluster-remote-info,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-remote-info @@ -107,13 +107,13 @@ cluster-update-settings,https://www.elastic.co/docs/api/doc/elasticsearch/operat cluster,https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-cluster cohere-api-keys,https://dashboard.cohere.com/api-keys cohere-models,https://docs.cohere.com/docs/models#command -common-options,https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html -community-id-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/community-id-processor.html +common-options,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/common-options +community-id-processor,https://www.elastic.co/docs/reference/enrich-processor/community-id-processor connector-sync-job-cancel,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-cancel connector-sync-job-checkin,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-check-in connector-sync-job-claim,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-claim connector-sync-job-error,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-error -collapse-search-results,https://www.elastic.co/guide/en/elasticsearch/reference/current/collapse-search-results.html +collapse-search-results,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/collapse-search-results connector-sync-job-delete,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-delete connector-sync-job-get,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-get connector-sync-job-post,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-post @@ -139,13 +139,13 @@ connector-update-pipeline,https://www.elastic.co/docs/api/doc/elasticsearch/oper connector-update-scheduling,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-scheduling connector-update-service-type,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-service-type connector-update-status,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-status -convert-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/convert-processor.html -cron-expressions,https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#api-cron-expressions -csv-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/csv-processor.html +convert-processor,https://www.elastic.co/docs/reference/enrich-processor/convert-processor +cron-expressions,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/api-conventions#api-cron-expressions +csv-processor,https://www.elastic.co/docs/reference/enrich-processor/csv-processor dangling-index-delete,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-dangling-indices-delete-dangling-index dangling-index-import,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-dangling-indices-import-dangling-index dangling-indices-list,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-dangling-indices-list-dangling-indices -data-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/date-processor.html +data-processor,https://www.elastic.co/docs/reference/enrich-processor/date-processor data-stream-delete,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-data-stream data-stream-delete-lifecycle,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-data-lifecycle data-stream-explain-lifecycle,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-explain-data-lifecycle @@ -157,10 +157,10 @@ data-stream-promote,https://www.elastic.co/docs/api/doc/elasticsearch/operation/ data-stream-put-lifecycle,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-data-lifecycle data-stream-stats-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-data-streams-stats-1 data-stream-update,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-modify-data-stream -data-streams,https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html -date-index-name-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/date-index-name-processor.html -dcg,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-rank-eval.html#_discounted_cumulative_gain_dcg -defining-roles,https://www.elastic.co/guide/en/elasticsearch/reference/current/defining-roles.html +data-streams,https://www.elastic.co/docs/manage-data/data-store/data-streams +date-index-name-processor,https://www.elastic.co/docs/reference/enrich-processor/date-index-name-processor +dcg,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/search-rank-eval.html +defining-roles,https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/defining-roles delete-analytics-collection,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-delete-behavioral-analytics delete-async-sql-search-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-delete-async delete-enrich-policy-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-delete-policy @@ -171,8 +171,8 @@ delete-synonyms-set,https://www.elastic.co/docs/api/doc/elasticsearch/operation/ delete-trained-models-aliases,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-trained-model-alias delete-trained-models,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-trained-model delete-transform,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-delete-transform -dissect-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/dissect-processor.html -distance-units,https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#distance-units +dissect-processor,https://www.elastic.co/docs/reference/enrich-processor/dissect-processor +distance-units,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/api-conventions#distance-units docs-bulk,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-bulk docs-delete-by-query,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete-by-query docs-delete-by-query-rethrottle,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete-by-query-rethrottle @@ -186,53 +186,53 @@ docs-termvectors,https://www.elastic.co/docs/api/doc/elasticsearch/operation/ope docs-update-by-query,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update-by-query docs-update-by-query-rethrottle,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update-by-query-rethrottle docs-update,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update -document-input-parameters,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-mlt-query.html#_document_input_parameters -docvalue-fields,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-fields.html#docvalue-fields -dot-expand-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/dot-expand-processor.html -drop-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/drop-processor.html -eland-import,https://www.elastic.co/guide/en/machine-learning/current/ml-nlp-import-model.html#ml-nlp-import-script -enrich-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-processor.html +document-input-parameters,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-mlt-query#_document_input_parameters +docvalue-fields,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#docvalue-fields +dot-expand-processor,https://www.elastic.co/docs/reference/enrich-processor/dot-expand-processor +drop-processor,https://www.elastic.co/docs/reference/enrich-processor/drop-processor +eland-import,https://www.elastic.co/docs/explore-analyze/machine-learning/nlp/ml-nlp-import-model#ml-nlp-import-script +enrich-processor,https://www.elastic.co/docs/reference/enrich-processor/enrich-processor enrich-stats-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-stats eql-async-search-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-get eql-async-search-delete,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-delete eql-async-search-status-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-get-status -eql-basic-syntax,https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html#eql-basic-syntax +eql-basic-syntax,https://www.elastic.co/docs/reference/query-languages/eql/eql-syntax#eql-basic-syntax eql-search-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-search -eql-sequences,https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html#eql-sequences -eql-missing-events,https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html#eql-missing-events -eql-syntax,https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-syntax.html -eql,https://www.elastic.co/guide/en/elasticsearch/reference/current/eql.html -esql,https://www.elastic.co/guide/en/elasticsearch/reference/current/esql.html +eql-sequences,https://www.elastic.co/docs/reference/query-languages/eql/eql-syntax#eql-sequences +eql-missing-events,https://www.elastic.co/docs/reference/query-languages/eql/eql-syntax#eql-missing-events +eql-syntax,https://www.elastic.co/docs/reference/query-languages/eql/eql-syntax +eql,https://www.elastic.co/docs/explore-analyze/query-filter/languages/eql +esql,https://www.elastic.co/docs/explore-analyze/query-filter/languages/esql esql-async-query,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-async-query esql-async-query-delete,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-async-query-delete esql-async-query-get,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-async-query-get esql-async-query-stop,https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-async-query-stop-api.html -esql-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-rest.html -esql-query-params,https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-rest.html#esql-rest-params -esql-returning-localized-results,https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-rest.html#esql-locale-param +esql-query,https://www.elastic.co/docs/explore-analyze/query-filter/languages/esql-rest +esql-query-params,https://www.elastic.co/docs/explore-analyze/query-filter/languages/esql-rest#esql-rest-params +esql-returning-localized-results,https://www.elastic.co/docs/explore-analyze/query-filter/languages/esql-rest#esql-locale-param evaluate-dfanalytics,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-evaluate-data-frame execute-enrich-policy-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-execute-policy -expected-reciprocal,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-rank-eval.html#_expected_reciprocal_rank_err +expected-reciprocal,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rank-eval#_expected_reciprocal_rank_err explain-dfanalytics,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-explain-data-frame-analytics -fail-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/fail-processor.html +fail-processor,https://www.elastic.co/docs/reference/enrich-processor/fail-processor features-reset,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-features-reset-features -field-and-document-access-control,https://www.elastic.co/guide/en/elasticsearch/reference/current/field-and-document-access-control.html +field-and-document-access-control,https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level field-usage-stats,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-field-usage-stats find-field-structure,https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-text_structure find-message-structure,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-text-structure-find-message-structure find-structure,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-text-structure-find-structure -fingerprint-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/fingerprint-processor.html +fingerprint-processor,https://www.elastic.co/docs/reference/enrich-processor/fingerprint-processor fleet-multi-search,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-fleet-msearch fleet-search,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-fleet-search -foreach-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/foreach-processor.html -fuzziness,https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness -gap-policy,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline.html#gap-policy -geo-shape,https://www.elastic.co/guide/en/elasticsearch/reference/current/geo-shape.html -geo-grid-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest-geo-grid-processor.html +foreach-processor,https://www.elastic.co/docs/reference/enrich-processor/foreach-processor +fuzziness,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/common-options#fuzziness +gap-policy,https://www.elastic.co/docs/reference/aggregations/pipeline#gap-policy +geo-shape,https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/geo-shape +geo-grid-processor,https://www.elastic.co/docs/reference/enrich-processor/ingest-geo-grid-processor geoip-delete-database,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-delete-geoip-database geoip-get-database,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-get-geoip-database geoip-put-database,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-put-geoip-database -geoip-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/geoip-processor.html +geoip-processor,https://www.elastic.co/docs/reference/enrich-processor/geoip-processor geoip-stats-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-geo-ip-stats get-basic-status,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-get-basic-status get-dfanalytics-stats,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-data-frame-analytics-stats @@ -254,18 +254,18 @@ get-trial-status,https://www.elastic.co/docs/api/doc/elasticsearch/operation/ope googlevertexai-locations,https://cloud.google.com/vertex-ai/generative-ai/docs/learn/locations googlevertexai-models,https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/text-embeddings-api googleaistudio-models,https://ai.google.dev/gemini-api/docs/models -graph,https://www.elastic.co/guide/en/kibana/current/xpack-graph.html +graph,https://www.elastic.co/docs/explore-analyze/visualize/graph graph-explore-api,https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-graph -grok,https://www.elastic.co/guide/en/elasticsearch/reference/current/grok.html -grok-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/grok-processor.html -gsub-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/gsub-processor.html +grok,https://www.elastic.co/docs/explore-analyze/scripting/grok +grok-processor,https://www.elastic.co/docs/reference/enrich-processor/grok-processor +gsub-processor,https://www.elastic.co/docs/reference/enrich-processor/gsub-processor health-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-health-report huggingface-tokens,https://huggingface.co/settings/tokens ilm-delete-lifecycle,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-delete-lifecycle ilm-explain-lifecycle,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-explain-lifecycle ilm-get-lifecycle,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-get-lifecycle ilm-get-status,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-get-status -ilm-index-lifecycle,https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-index-lifecycle.html +ilm-index-lifecycle,https://www.elastic.co/docs/manage-data/lifecycle/index-lifecycle-management/index-lifecycle ilm-migrate-to-data-tiers,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-migrate-to-data-tiers ilm-move-to-step,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-move-to-step ilm-put-lifecycle,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-put-lifecycle @@ -273,16 +273,16 @@ ilm-remove-policy,https://www.elastic.co/docs/api/doc/elasticsearch/operation/op ilm-retry-policy,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-retry ilm-start,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-start ilm-stop,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-stop -important-settings,https://www.elastic.co/guide/en/elasticsearch/reference/current/important-settings.html +important-settings,https://www.elastic.co/docs/deploy-manage/deploy/self-managed/important-settings-configuration index-block-add,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-add-block -index-modules-blocks,https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules-blocks.html -index-modules-settings,https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#index-modules-settings -index-modules-slowlog-slowlog,https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules-slowlog.html#index-slow-log -index-modules,https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html -index,https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html -indexing-buffer,https://www.elastic.co/guide/en/elasticsearch/reference/current/indexing-buffer.html -index-modules-merge,https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules-merge.html -index-templates,https://www.elastic.co/guide/en/elasticsearch/reference/current/index-templates.html +index-modules-blocks,https://www.elastic.co/docs/reference/elasticsearch/index-settings/index-block +index-modules-settings,https://www.elastic.co/docs/reference/elasticsearch/index-settings/index-modules +index-modules-slowlog-slowlog,https://www.elastic.co/docs/reference/elasticsearch/index-settings/slow-log#index-slow-log +index-modules,https://www.elastic.co/docs/reference/elasticsearch/index-settings/index-modules +index,https://www.elastic.co/docs/get-started +indexing-buffer,https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/indexing-buffer-settings +index-modules-merge,https://www.elastic.co/docs/reference/elasticsearch/index-settings/merge +index-templates,https://www.elastic.co/docs/manage-data/data-store/templates index-templates-exist,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists-index-template index-templates-put,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-index-template index-templates-v1,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-template @@ -327,10 +327,10 @@ indices-simulate-template,https://www.elastic.co/docs/api/doc/elasticsearch/oper indices-split-index,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-split indices-stats,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-stats indices-template-exists-v1,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists-template -indices-templates,https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html +indices-templates,https://www.elastic.co/docs/manage-data/data-store/templates indices-update-settings,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-settings infer-trained-model,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-infer-trained-model -infer-trained-model-deployment,https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-trained-model-deployment.html +infer-trained-model-deployment,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-infer-trained-model inference-api-delete,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-delete inference-api-get,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-get inference-api-post,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-inference @@ -356,54 +356,53 @@ inference-api-put-watsonx,https://www.elastic.co/docs/api/doc/elasticsearch/oper inference-api-stream,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-stream-inference inference-api-chat-completion,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-unified-inference inference-api-update,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-update -inference-chunking,https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-apis.html#infer-chunking-config -inference-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/inference-processor.html +inference-chunking,https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#infer-chunking-config +inference-processor,https://www.elastic.co/docs/reference/enrich-processor/inference-processor info-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-info -ingest,https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html -ingest-circle-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest-circle-processor.html +ingest,https://www.elastic.co/docs/manage-data/ingest/transform-enrich/ingest-pipelines +ingest-circle-processor,https://www.elastic.co/docs/reference/enrich-processor/ingest-circle-processor ingest-node-set-security-user-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{banch}/ingest-node-set-security-user-processor.html -inner-hits,https://www.elastic.co/guide/en/elasticsearch/reference/current/inner-hits.html +inner-hits,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-inner-hits ip-location-delete-database,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-delete-ip-location-database ip-location-get-database,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-get-ip-location-database ip-location-put-database,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-put-ip-location-database jinaAi-embeddings,https://jina.ai/embeddings/ jinaAi-rate-limit,https://jina.ai/contact-sales/#rate-limit -join-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/join-processor.html -json-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/json-processor.html -k-precision,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-rank-eval.html#k-precision -k-recall,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-rank-eval.html#k-recall -kv-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/kv-processor.html -knn-approximate,https://www.elastic.co/guide/en/elasticsearch/reference/current/knn-search.html#approximate-knn -knn-inner-hits,https://www.elastic.co/guide/en/elasticsearch/reference/current/knn-search.html#nested-knn-search-inner-hits -license-management,https://www.elastic.co/guide/en/kibana/current/managing-licenses.html +join-processor,https://www.elastic.co/docs/reference/enrich-processor/join-processor +json-processor,https://www.elastic.co/docs/reference/enrich-processor/json-processor +k-precision,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rank-eval#k-precision +k-recall,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/search-rank-eval.html#k-recall +kv-processor,https://www.elastic.co/docs/reference/enrich-processor/kv-processor +knn-approximate,https://www.elastic.co/docs/solutions/search/vector/knn#approximate-knn +knn-inner-hits,https://www.elastic.co/docs/solutions/search/vector/knn#nested-knn-search-inner-hits +license-management,https://www.elastic.co/docs/deploy-manage/license/manage-your-license-in-self-managed-cluster list-analytics-collection,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-get-behavioral-analytics list-synonyms-sets,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-get-synonyms-sets logstash-api-delete-pipeline,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-logstash-delete-pipeline logstash-api-get-pipeline,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-logstash-get-pipeline logstash-api-put-pipeline,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-logstash-put-pipeline -logstash-centralized-pipeline-management,https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html -logstash-configuration-file-structure,https://www.elastic.co/guide/en/logstash/current/configuration-file-structure.html -logstash-logstash-settings-file,https://www.elastic.co/guide/en/logstash/current/logstash-settings-file.html -lowercase-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/lowercase-processor.html +logstash-centralized-pipeline-management,https://www.elastic.co/docs/reference/logstash/logstash-centralized-pipeline-management +logstash-configuration-file-structure,https://www.elastic.co/docs/reference/logstash/configuration-file-structure +logstash-logstash-settings-file,https://www.elastic.co/docs/reference/logstash/logstash-settings-file +lowercase-processor,https://www.elastic.co/docs/reference/enrich-processor/lowercase-processor mapbox-vector-tile,https://github.com/mapbox/vector-tile-spec/blob/master/README.md -mapping-date-format,https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-date-format.html -mapping-meta-field,https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html -mapping-params,https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-params.html -mapping-metadata,https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-fields.html -mapping-roles,https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-roles.html -mapping-settings-limit,https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-settings-limit.html -mapping-source-field,https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-source-field.html -mapping,https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping.html -mapping,https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping.html -mean-reciprocal,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-rank-eval.html#_mean_reciprocal_rank +mapping-date-format,https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-date-format +mapping-meta-field,https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-meta-field +mapping-params,https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-parameters +mapping-metadata,https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/document-metadata-fields +mapping-roles,https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/mapping-users-groups-to-roles +mapping-settings-limit,https://www.elastic.co/docs/reference/elasticsearch/index-settings/mapping-limit +mapping-source-field,https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-source-field +mapping,https://www.elastic.co/docs/manage-data/data-store/mapping +mean-reciprocal,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/search-rank-eval.html#_mean_reciprocal_rank migrate,https://www.elastic.co/guide/en/elasticsearch/reference/current/migrate-data-stream.html -migrate-index-allocation-filters,https://www.elastic.co/guide/en/elasticsearch/reference/current/migrate-index-allocation-filters.html +migrate-index-allocation-filters,https://www.elastic.co/docs/manage-data/lifecycle/index-lifecycle-management/migrate-index-allocation-filters-to-node-roles migration-api-deprecation,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-migration-deprecations migration-api-feature-upgrade,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-migration-get-feature-upgrade-status mistral-api-keys,https://console.mistral.ai/api-keys/ mistral-api-models,https://docs.mistral.ai/getting-started/models/ ml-apis,https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-ml -ml-classification,https://www.elastic.co/guide/en/machine-learning/current/ml-dfa-classification.html +ml-classification,https://www.elastic.co/docs/explore-analyze/machine-learning/data-frame-analytics/ml-dfa-classification ml-close-job,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-close-job ml-delete-calendar-event,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-calendar-event ml-delete-calendar-job,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-calendar-job @@ -416,10 +415,10 @@ ml-delete-forecast,https://www.elastic.co/docs/api/doc/elasticsearch/operation/o ml-delete-job,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-job ml-delete-snapshot,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-model-snapshot ml-estimate-memory,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-estimate-model-memory -ml-feature-importance,https://www.elastic.co/guide/en/machine-learning/current/ml-feature-importance.html +ml-feature-importance,https://www.elastic.co/docs/explore-analyze/machine-learning/data-frame-analytics/ml-feature-importance ml-flush-job,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-flush-job ml-forecast,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-forecast -ml-functions,https://www.elastic.co/guide/en/machine-learning/current/ml-functions.html +ml-functions,https://www.elastic.co/docs/explore-analyze/machine-learning/anomaly-detection/ml-functions ml-get-bucket,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-buckets ml-get-calendar-event,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-calendar-events ml-get-calendar,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-calendars @@ -435,8 +434,8 @@ ml-get-memory,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operat ml-get-overall-buckets,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-overall-buckets ml-get-record,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-records ml-get-snapshot,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-model-snapshots -ml-jobs,https://www.elastic.co/guide/en/machine-learning/current/ml-jobs.html -ml-model-snapshots,https://www.elastic.co/guide/en/machine-learning/current/ml-ad-run-jobs.html#ml-ad-model-snapshots +ml-jobs,https://www.elastic.co/docs/explore-analyze/machine-learning/anomaly-detection/ml-ad-run-jobs +ml-model-snapshots,https://www.elastic.co/docs/explore-analyze/machine-learning/anomaly-detection/ml-ad-run-jobs#ml-ad-model-snapshots ml-open-job,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-open-job ml-post-calendar-event,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-post-calendar-events ml-post-data,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-post-data @@ -446,12 +445,12 @@ ml-put-calendar,https://www.elastic.co/docs/api/doc/elasticsearch/operation/oper ml-put-datafeed,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-datafeed ml-put-filter,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-filter ml-put-job,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-job -ml-regression-loss,https://www.elastic.co/guide/en/machine-learning/current/dfa-regression-lossfunction.html -ml-regression,https://www.elastic.co/guide/en/machine-learning/current/ml-dfa-regression.html +ml-regression-loss,https://www.elastic.co/docs/explore-analyze/machine-learning/data-frame-analytics/dfa-regression-lossfunction +ml-regression,https://www.elastic.co/docs/explore-analyze/machine-learning/data-frame-analytics/ml-dfa-regression ml-reset-job,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-reset-job ml-revert-snapshot,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-revert-model-snapshot ml-set-upgrade-mode,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-set-upgrade-mode -ml-settings,https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-settings.html +ml-settings,https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/machine-learning-settings ml-start-datafeed,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-start-datafeed ml-stop-datafeed,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-stop-datafeed ml-update-datafeed,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-datafeed @@ -459,30 +458,30 @@ ml-update-filter,https://www.elastic.co/docs/api/doc/elasticsearch/operation/ope ml-update-job,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-job ml-update-snapshot,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-model-snapshot ml-upgrade-job-model-snapshot,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-upgrade-job-snapshot -modules-cluster,https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-cluster.html -modules-cross-cluster-search,https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-cross-cluster-search.html -modules-discovery-hosts-providers,https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-discovery-hosts-providers.html -modules-fielddata,https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-fielddata.html -modules-gateway-dangling-indices,https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-gateway-dangling-indices.html -modules-node,https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-node.html -modules-remote-clusters,https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-remote-clusters.html -modules-scripting,https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html -modules-snapshots,https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html -monitor-elasticsearch-cluster,https://www.elastic.co/guide/en/elasticsearch/reference/current/monitor-elasticsearch-cluster.html -multi-fields,https://www.elastic.co/guide/en/elasticsearch/reference/current/multi-fields.html -network-direction-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/network-direction-processor.html -node-roles,https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-node.html#node-roles +modules-cluster,https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/cluster-level-shard-allocation-routing-settings +modules-cross-cluster-search,https://www.elastic.co/docs/solutions/search/cross-cluster-search +modules-discovery-hosts-providers,https://www.elastic.co/docs/deploy-manage/distributed-architecture/discovery-cluster-formation/discovery-hosts-providers +modules-fielddata,https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/field-data-cache-settings +modules-gateway-dangling-indices,https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/local-gateway +modules-node,https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/node-settings +modules-remote-clusters,https://www.elastic.co/docs/deploy-manage/remote-clusters/remote-clusters-self-managed +modules-scripting,https://www.elastic.co/docs/explore-analyze/scripting +modules-snapshots,https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore +monitor-elasticsearch-cluster,https://www.elastic.co/docs/deploy-manage/monitor/cloud-health-perf +multi-fields,https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/multi-fields +network-direction-processor,https://www.elastic.co/docs/reference/enrich-processor/network-direction-processor +node-roles,https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/node-settings#node-roles nodes-api-shutdown-delete,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-shutdown-delete-node nodes-api-shutdown-status,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-shutdown-get-node nodes-api-shutdown,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-shutdown-put-node openai-api-keys,https://platform.openai.com/api-keys openai-models,https://platform.openai.com/docs/guides/embeddings/what-are-embeddings -optimistic-concurrency,https://www.elastic.co/guide/en/elasticsearch/reference/current/optimistic-concurrency-control.html -paginate-search-results,https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html -painless-contexts,https://www.elastic.co/guide/en/elasticsearch/painless/current/painless-contexts.html -painless-execute-api,https://www.elastic.co/guide/en/elasticsearch/painless/current/painless-execute-api.html -pipeline-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/pipeline-processor.html -pki-realm,https://www.elastic.co/guide/en/elasticsearch/reference/current/pki-realm.html +optimistic-concurrency,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control +paginate-search-results,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results +painless-contexts,https://www.elastic.co/docs/reference/scripting-languages/painless/painless-contexts +painless-execute-api,https://www.elastic.co/docs/reference/scripting-languages/painless/painless-api-examples +pipeline-processor,https://www.elastic.co/docs/reference/enrich-processor/pipeline-processor +pki-realm,https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/pki point-in-time-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-open-point-in-time prevalidate-node-removal,https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-cluster preview-dfanalytics,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-preview-data-frame-analytics @@ -498,69 +497,69 @@ put-trained-model-vocabulary,https://www.elastic.co/docs/api/doc/elasticsearch/o put-trained-models-aliases,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-trained-model-alias put-trained-models,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-trained-model put-transform,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-put-transform -query-dsl-bool-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-query.html -query-dsl-boosting-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-boosting-query.html -query-dsl-combined-fields-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-combined-fields-query.html -query-dsl-constant-score-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-constant-score-query.html -query-dsl-dis-max-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-dis-max-query.html -query-dsl-distance-feature-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-distance-feature-query.html -query-dsl-exists-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-exists-query.html -query-dsl-function-score-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-function-score-query.html -query-dsl-fuzzy-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-fuzzy-query.html -query-dsl-geo-bounding-box-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-bounding-box-query.html -query-dsl-geo-distance-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-distance-query.html -query-dsl-geo-polygon-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-polygon-query.html -query-dsl-geo-shape-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-shape-query.html -query-dsl-has-child-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-has-child-query.html -query-dsl-has-parent-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-has-parent-query.html -query-dsl-ids-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-ids-query.html -query-dsl-intervals-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-intervals-query.html -query-dsl-knn-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-knn-query.html -query-dsl-match-all-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-all-query.html -query-dsl-match-bool-prefix-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-bool-prefix-query.html -query-dsl-match-none-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-all-query.html#query-dsl-match-none-query -query-dsl-match-query-phrase-prefix,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query-phrase-prefix.html -query-dsl-match-query-phrase,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query-phrase.html -query-dsl-match-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query.html -query-dsl-minimum-should-match,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html -query-dsl-minimum-should-match,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-minimum-should-match.html -query-dsl-mlt-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-mlt-query.html -query-dsl-multi-match-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-match-query.html -query-dsl-multi-term-rewrite,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-term-rewrite.html -query-dsl-nested-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-nested-query.html -query-dsl-parent-id-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-parent-id-query.html -query-dsl-percolate-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-percolate-query.html -query-dsl-pinned-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-pinned-query.html -query-dsl-prefix-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-prefix-query.html -query-dsl-query-string-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html -query-dsl-range-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html -query-dsl-rank-feature-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-rank-feature-query.html -query-dsl-regexp-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-regexp-query.html -query-dsl-rule-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-rule-query.html -query-dsl-script-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-script-query.html -query-dsl-script-score-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-script-score-query.html -query-dsl-semantic-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-semantic-query.html -query-dsl-shape-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-shape-query.html -query-dsl-simple-query-string-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html -query-dsl-span-containing-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-containing-query.html -query-dsl-span-field-masking-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-field-masking-query.html -query-dsl-span-first-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-first-query.html -query-dsl-span-multi-term-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-multi-term-query.html -query-dsl-span-near-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-near-query.html -query-dsl-span-not-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-not-query.html -query-dsl-span-or-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-or-query.html -query-dsl-span-term-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-term-query.html -query-dsl-span-within-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-span-within-query.html -query-dsl-sparse-vector-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-sparse-vector-query.html -query-dsl-term-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-term-query.html -query-dsl-terms-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-query.html -query-dsl-terms-set-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-set-query.html -query-dsl-text-expansion-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-text-expansion-query.html -query-dsl-weighted-tokens-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-weighted-tokens-query.html -query-dsl-wildcard-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-wildcard-query.html -query-dsl-wrapper-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-wrapper-query.html -query-dsl,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html -query-rule,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-using-query-rules.html +query-dsl-bool-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-bool-query +query-dsl-boosting-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-boosting-query +query-dsl-combined-fields-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-combined-fields-query +query-dsl-constant-score-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-constant-score-query +query-dsl-dis-max-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-dis-max-query +query-dsl-distance-feature-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-distance-feature-query +query-dsl-exists-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-exists-query +query-dsl-function-score-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-function-score-query +query-dsl-fuzzy-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-fuzzy-query +query-dsl-geo-bounding-box-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-bounding-box-query +query-dsl-geo-distance-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-distance-query +query-dsl-geo-polygon-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-polygon-query +query-dsl-geo-shape-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-shape-query +query-dsl-has-child-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-has-child-query +query-dsl-has-parent-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-has-parent-query +query-dsl-ids-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-ids-query +query-dsl-intervals-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-intervals-query +query-dsl-knn-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-knn-query +query-dsl-match-all-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-all-query +query-dsl-match-bool-prefix-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-bool-prefix-query +query-dsl-match-none-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-all-query#query-dsl-match-none-query +query-dsl-match-query-phrase-prefix,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query-phrase-prefix +query-dsl-match-query-phrase,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query-phrase +query-dsl-match-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query +query-dsl-minimum-should-match,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-minimum-should-match +query-dsl-minimum-should-match,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-minimum-should-match +query-dsl-mlt-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-mlt-query +query-dsl-multi-match-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-multi-match-query +query-dsl-multi-term-rewrite,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-multi-term-rewrite +query-dsl-nested-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-nested-query +query-dsl-parent-id-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-parent-id-query +query-dsl-percolate-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-percolate-query +query-dsl-pinned-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-pinned-query +query-dsl-prefix-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-prefix-query +query-dsl-query-string-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-query-string-query +query-dsl-range-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-range-query +query-dsl-rank-feature-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-rank-feature-query +query-dsl-regexp-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-regexp-query +query-dsl-rule-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-rule-query +query-dsl-script-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-script-query +query-dsl-script-score-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-script-score-query +query-dsl-semantic-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-semantic-query +query-dsl-shape-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-shape-query +query-dsl-simple-query-string-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-simple-query-string-query +query-dsl-span-containing-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-containing-query +query-dsl-span-field-masking-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-field-masking-query +query-dsl-span-first-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-first-query +query-dsl-span-multi-term-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-multi-term-query +query-dsl-span-near-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-near-query +query-dsl-span-not-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-not-query +query-dsl-span-or-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-query +query-dsl-span-term-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-term-query +query-dsl-span-within-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-within-query +query-dsl-sparse-vector-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-sparse-vector-query +query-dsl-term-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-term-query +query-dsl-terms-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-terms-query +query-dsl-terms-set-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-terms-set-query +query-dsl-text-expansion-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-text-expansion-query +query-dsl-weighted-tokens-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-weighted-tokens-query +query-dsl-wildcard-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-wildcard-query +query-dsl-wrapper-query,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-wrapper-query +query-dsl,https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl +query-rule,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/searching-with-query-rules query-rule-delete,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-delete-rule query-rule-get,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-get-rule query-rule-put,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-put-rule @@ -569,136 +568,136 @@ query-ruleset-get,https://www.elastic.co/docs/api/doc/elasticsearch/operation/op query-ruleset-list,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-list-rulesets query-ruleset-put,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-put-ruleset query-ruleset-test,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-test -realtime,https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#realtime -redact-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/redact-processor.html -regexp-syntax,https://www.elastic.co/guide/en/elasticsearch/reference/current/regexp-syntax.html -register-repository,https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-register-repository.html -registered-domain-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/registered-domain-processor.html -relevance-scores,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html#relevance-scores -remove-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/remove-processor.html -remote-clusters-api-key,https://www.elastic.co/guide/en/elasticsearch/reference/current/remote-clusters-api-key.html -rename-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/rename-processor.html -repository-azure,https://www.elastic.co/guide/en/elasticsearch/reference/current/repository-azure.html -repository-gcs,https://www.elastic.co/guide/en/elasticsearch/reference/current/repository-gcs.html -repository-read-only,https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-read-only-repository.html -repository-s3,https://www.elastic.co/guide/en/elasticsearch/reference/current/repository-s3.html +realtime,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get +redact-processor,https://www.elastic.co/docs/reference/enrich-processor/redact-processor +regexp-syntax,https://www.elastic.co/docs/reference/query-languages/query-dsl/regexp-syntax +register-repository,https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/self-managed +registered-domain-processor,https://www.elastic.co/docs/reference/enrich-processor/registered-domain-processor +relevance-scores,https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl#relevance-scores +remove-processor,https://www.elastic.co/docs/reference/enrich-processor/remove-processor +remote-clusters-api-key,https://www.elastic.co/docs/deploy-manage/remote-clusters/remote-clusters-api-key +rename-processor,https://www.elastic.co/docs/reference/enrich-processor/rename-processor +repository-azure,https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/azure-repository +repository-gcs,https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/google-cloud-storage-repository +repository-read-only,https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/read-only-url-repository +repository-s3,https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/s3-repository repository-s3-canned-acl,https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl repository-s3-delete-objects,https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjects.html repository-s3-list-multipart,https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html repository-s3-naming,https://docs.aws.amazon.com/AmazonS3/latest/userguide/BucketRestrictions.html#bucketnamingrules -repository-s3-storage-classes,https://www.elastic.co/guide/en/elasticsearch/reference/current/repository-s3.html#repository-s3-storage-classes -repository-shared-fs,https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-filesystem-repository.html -repository-source-only,https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-source-only-repository.html -reroute-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/reroute-processor.html +repository-s3-storage-classes,https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/s3-repository#repository-s3-storage-classes +repository-shared-fs,https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/shared-file-system-repository +repository-source-only,https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/source-only-repository +reroute-processor,https://www.elastic.co/docs/reference/enrich-processor/reroute-processor render-search-template-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-render-search-template reset-transform,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-reset-transform -restore-snapshot,https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-restore-snapshot.html -role-restriction,https://www.elastic.co/guide/en/elasticsearch/reference/current/role-restriction.html -rollup-agg-limitations,https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-agg-limitations.html +restore-snapshot,https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/restore-snapshot +role-restriction,https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/role-restriction +rollup-agg-limitations,https://www.elastic.co/docs/manage-data/lifecycle/rollup/rollup-aggregation-limitations rollup-delete-job,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-delete-job rollup-get-job,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-get-jobs rollup-get-rollup-caps,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-get-rollup-caps rollup-get-rollup-index-caps,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-get-rollup-index-caps rollup-put-job,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-put-job rollup-search,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-rollup-search -rollup-search-limitations,https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-search-limitations.html +rollup-search-limitations,https://www.elastic.co/docs/manage-data/lifecycle/rollup/rollup-search-limitations rollup-start-job,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-start-job rollup-stop-job,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-stop-job -routing,https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#get-routing -run-as-privilege,https://www.elastic.co/guide/en/elasticsearch/reference/current/run-as-privilege.html -runtime-search-request,https://www.elastic.co/guide/en/elasticsearch/reference/current/runtime-search-request.html +routing,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get#get-routing +run-as-privilege,https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/submitting-requests-on-behalf-of-other-users +runtime-search-request,https://www.elastic.co/docs/manage-data/data-store/mapping/define-runtime-fields-in-search-request schedule-now-transform,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-schedule-now-transform script-contexts,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get-script-context script-delete,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete-script script-get,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get-script script-languages,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get-script-languages -script-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/script-processor.html +script-processor,https://www.elastic.co/docs/reference/enrich-processor/script-processor script-put,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-put-script scroll-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-scroll -scroll-search-results,https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results -search-after,https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#search-after -search-aggregations,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations.html -search-aggregations-bucket-adjacency-matrix-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-adjacency-matrix-aggregation.html -search-aggregations-bucket-autodatehistogram-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-autodatehistogram-aggregation.html -search-aggregations-bucket-categorize-text-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-categorize-text-aggregation.html -search-aggregations-bucket-children-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-children-aggregation.html -search-aggregations-bucket-correlation-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-correlation-aggregation.html -search-aggregations-bucket-count-ks-test-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-count-ks-test-aggregation.html -search-aggregations-bucket-datehistogram-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-datehistogram-aggregation.html -search-aggregations-bucket-daterange-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-daterange-aggregation.html -search-aggregations-bucket-diversified-sampler-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-diversified-sampler-aggregation.html -search-aggregations-bucket-filter-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filter-aggregation.html -search-aggregations-bucket-frequent-item-sets-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-frequent-item-sets-aggregation.html -search-aggregations-bucket-significantterms-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-significantterms-aggregation.html -search-aggregations-metrics-avg-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-avg-aggregation.html -search-aggregations-metrics-boxplot-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-boxplot-aggregation.html -search-aggregations-metrics-cardinality-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-cardinality-aggregation.html -search-aggregations-metrics-extendedstats-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-extendedstats-aggregation.html -search-aggregations-pipeline-avg-bucket-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-avg-bucket-aggregation.html -search-aggregations-pipeline-bucket-path,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline.html#buckets-path-syntax -search-aggregations-pipeline-bucket-script-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-bucket-script-aggregation.html -search-aggregations-pipeline-bucket-selector-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-bucket-selector-aggregation.html -search-aggregations-pipeline-bucket-sort-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-bucket-sort-aggregation.html -search-aggregations-bucket-composite-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-composite-aggregation.html -search-aggregations-pipeline-cumulative-cardinality-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-cumulative-cardinality-aggregation.html -search-aggregations-pipeline-cumulative-sum-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-cumulative-sum-aggregation.html -search-aggregations-pipeline-derivative-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-derivative-aggregation.html -search-aggregations-pipeline-extended-stats-bucket-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-extended-stats-bucket-aggregation.html -search-aggregations-bucket-frequent-item-sets-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-frequent-item-sets-aggregation.html -search-aggregations-bucket-filter-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filter-aggregation.html -search-aggregations-bucket-filters-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filters-aggregation.html -search-aggregations-metrics-geobounds-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-geobounds-aggregation.html -search-aggregations-metrics-geocentroid-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-geocentroid-aggregation.html -search-aggregations-bucket-geodistance-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-geodistance-aggregation.html -search-aggregations-bucket-geohashgrid-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-geohashgrid-aggregation.html -search-aggregations-metrics-geo-line,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-geo-line.html -search-aggregations-bucket-geotilegrid-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-geotilegrid-aggregation.html -search-aggregations-bucket-geohexgrid-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-geohexgrid-aggregation.html -search-aggregations-bucket-global-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-global-aggregation.html -search-aggregations-bucket-histogram-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-histogram-aggregation.html -search-aggregations-bucket-iprange-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-iprange-aggregation.html -search-aggregations-bucket-ipprefix-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-ipprefix-aggregation.html -search-aggregations-pipeline-inference-bucket-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-inference-bucket-aggregation.html -search-aggregations-matrix-stats-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-matrix-stats-aggregation.html -search-aggregations-metrics-max-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-max-aggregation.html -search-aggregations-pipeline-max-bucket-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-max-bucket-aggregation.html -search-aggregations-metrics-median-absolute-deviation-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-median-absolute-deviation-aggregation.html -search-aggregations-metrics-min-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-min-aggregation.html -search-aggregations-pipeline-min-bucket-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-min-bucket-aggregation.html -search-aggregations-bucket-missing-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-missing-aggregation.html -search-aggregations-pipeline-moving-percentiles-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-moving-percentiles-aggregation.html -search-aggregations-pipeline-movfn-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-movfn-aggregation.html -search-aggregations-bucket-multi-terms-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-multi-terms-aggregation.html -search-aggregations-bucket-nested-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-nested-aggregation.html -search-aggregations-pipeline-normalize-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-normalize-aggregation.html -search-aggregations-bucket-parent-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-parent-aggregation.html -search-aggregations-metrics-percentile-rank-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-percentile-rank-aggregation.html -search-aggregations-metrics-percentile-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-percentile-aggregation.html -search-aggregations-pipeline-percentiles-bucket-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-percentiles-bucket-aggregation.html -search-aggregations-bucket-range-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-range-aggregation.html -search-aggregations-bucket-rare-terms-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-rare-terms-aggregation.html -search-aggregations-metrics-rate-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-rate-aggregation.html -search-aggregations-bucket-reverse-nested-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-reverse-nested-aggregation.html -search-aggregations-bucket-sampler-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-sampler-aggregation.html -search-aggregations-random-sampler-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-random-sampler-aggregation.html -search-aggregations-metrics-scripted-metric-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-scripted-metric-aggregation.html -search-aggregations-pipeline-serialdiff-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-serialdiff-aggregation.html -search-aggregations-bucket-significantterms-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-significantterms-aggregation.html -search-aggregations-bucket-significanttext-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-significanttext-aggregation.html -search-aggregations-metrics-stats-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-stats-aggregation.html -search-aggregations-pipeline-stats-bucket-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-stats-bucket-aggregation.html -search-aggregations-metrics-string-stats-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-string-stats-aggregation.html -search-aggregations-metrics-sum-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-sum-aggregation.html -search-aggregations-pipeline-sum-bucket-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-sum-bucket-aggregation.html -search-aggregations-bucket-terms-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-terms-aggregation.html -search-aggregations-bucket-time-series-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-time-series-aggregation.html -search-aggregations-metrics-top-hits-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-top-hits-aggregation.html -search-aggregations-metrics-ttest-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-ttest-aggregation.html -search-aggregations-metrics-top-metrics,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-top-metrics.html -search-aggregations-metrics-valuecount-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-valuecount-aggregation.html -search-aggregations-metrics-weight-avg-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-weight-avg-aggregation.html -search-aggregations-bucket-variablewidthhistogram-aggregation,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-variablewidthhistogram-aggregation.html -search-analyzer,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-analyzer.html +scroll-search-results,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#scroll-search-results +search-after,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#search-after +search-aggregations,https://www.elastic.co/docs/explore-analyze/query-filter/aggregations +search-aggregations-bucket-adjacency-matrix-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-adjacency-matrix-aggregation +search-aggregations-bucket-autodatehistogram-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-autodatehistogram-aggregation +search-aggregations-bucket-categorize-text-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-categorize-text-aggregation +search-aggregations-bucket-children-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-children-aggregation +search-aggregations-bucket-correlation-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-correlation-aggregation +search-aggregations-bucket-count-ks-test-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-count-ks-test-aggregation +search-aggregations-bucket-datehistogram-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-datehistogram-aggregation +search-aggregations-bucket-daterange-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-daterange-aggregation +search-aggregations-bucket-diversified-sampler-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-diversified-sampler-aggregation +search-aggregations-bucket-filter-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-filter-aggregation +search-aggregations-bucket-frequent-item-sets-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-frequent-item-sets-aggregation +search-aggregations-bucket-significantterms-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-significantterms-aggregation +search-aggregations-metrics-avg-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-avg-aggregation +search-aggregations-metrics-boxplot-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-boxplot-aggregation +search-aggregations-metrics-cardinality-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-cardinality-aggregation +search-aggregations-metrics-extendedstats-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-extendedstats-aggregation +search-aggregations-pipeline-avg-bucket-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-avg-bucket-aggregation +search-aggregations-pipeline-bucket-path,https://www.elastic.co/docs/reference/aggregations/pipeline#buckets-path-syntax +search-aggregations-pipeline-bucket-script-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-bucket-script-aggregation +search-aggregations-pipeline-bucket-selector-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-bucket-selector-aggregation +search-aggregations-pipeline-bucket-sort-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-bucket-sort-aggregation +search-aggregations-bucket-composite-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-composite-aggregation +search-aggregations-pipeline-cumulative-cardinality-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-cumulative-cardinality-aggregation +search-aggregations-pipeline-cumulative-sum-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-cumulative-sum-aggregation +search-aggregations-pipeline-derivative-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-derivative-aggregation +search-aggregations-pipeline-extended-stats-bucket-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-extended-stats-bucket-aggregation +search-aggregations-bucket-frequent-item-sets-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-frequent-item-sets-aggregation +search-aggregations-bucket-filter-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-filter-aggregation +search-aggregations-bucket-filters-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-filters-aggregation +search-aggregations-metrics-geobounds-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-geobounds-aggregation +search-aggregations-metrics-geocentroid-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-geocentroid-aggregation +search-aggregations-bucket-geodistance-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geodistance-aggregation +search-aggregations-bucket-geohashgrid-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geohashgrid-aggregation +search-aggregations-metrics-geo-line,https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-geo-line +search-aggregations-bucket-geotilegrid-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geotilegrid-aggregation +search-aggregations-bucket-geohexgrid-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geohexgrid-aggregation +search-aggregations-bucket-global-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-global-aggregation +search-aggregations-bucket-histogram-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-histogram-aggregation +search-aggregations-bucket-iprange-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-iprange-aggregation +search-aggregations-bucket-ipprefix-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-ipprefix-aggregation +search-aggregations-pipeline-inference-bucket-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-inference-bucket-aggregation +search-aggregations-matrix-stats-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-matrix-stats-aggregation +search-aggregations-metrics-max-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-max-aggregation +search-aggregations-pipeline-max-bucket-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-max-bucket-aggregation +search-aggregations-metrics-median-absolute-deviation-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-median-absolute-deviation-aggregation +search-aggregations-metrics-min-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-min-aggregation +search-aggregations-pipeline-min-bucket-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-min-bucket-aggregation +search-aggregations-bucket-missing-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-missing-aggregation +search-aggregations-pipeline-moving-percentiles-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-moving-percentiles-aggregation +search-aggregations-pipeline-movfn-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-movfn-aggregation +search-aggregations-bucket-multi-terms-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-multi-terms-aggregation +search-aggregations-bucket-nested-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-nested-aggregation +search-aggregations-pipeline-normalize-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-normalize-aggregation +search-aggregations-bucket-parent-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-parent-aggregation +search-aggregations-metrics-percentile-rank-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-percentile-rank-aggregation +search-aggregations-metrics-percentile-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-percentile-aggregation +search-aggregations-pipeline-percentiles-bucket-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-percentiles-bucket-aggregation +search-aggregations-bucket-range-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-range-aggregation +search-aggregations-bucket-rare-terms-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-rare-terms-aggregation +search-aggregations-metrics-rate-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-rate-aggregation +search-aggregations-bucket-reverse-nested-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-reverse-nested-aggregation +search-aggregations-bucket-sampler-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-sampler-aggregation +search-aggregations-random-sampler-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-random-sampler-aggregation +search-aggregations-metrics-scripted-metric-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-scripted-metric-aggregation +search-aggregations-pipeline-serialdiff-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-serialdiff-aggregation +search-aggregations-bucket-significantterms-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-significantterms-aggregation +search-aggregations-bucket-significanttext-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-significanttext-aggregation +search-aggregations-metrics-stats-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-stats-aggregation +search-aggregations-pipeline-stats-bucket-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-stats-bucket-aggregation +search-aggregations-metrics-string-stats-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-string-stats-aggregation +search-aggregations-metrics-sum-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-sum-aggregation +search-aggregations-pipeline-sum-bucket-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-sum-bucket-aggregation +search-aggregations-bucket-terms-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-terms-aggregation +search-aggregations-bucket-time-series-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-time-series-aggregation +search-aggregations-metrics-top-hits-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-top-hits-aggregation +search-aggregations-metrics-ttest-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-ttest-aggregation +search-aggregations-metrics-top-metrics,https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-top-metrics +search-aggregations-metrics-valuecount-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-valuecount-aggregation +search-aggregations-metrics-weight-avg-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-weight-avg-aggregation +search-aggregations-bucket-variablewidthhistogram-aggregation,https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-variablewidthhistogram-aggregation +search-analyzer,https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/search-analyzer search-application-delete,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-delete search-application-get,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-get search-application-put,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-put @@ -707,26 +706,25 @@ search-render-query,https://www.elastic.co/docs/api/doc/elasticsearch/operation/ search-count,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-count search-explain,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-explain search-field-caps,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-field-caps -search-knn,https://www.elastic.co/guide/en/elasticsearch/reference/current/knn-search-api.html +search-knn,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-knn-search search-multi-search,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-msearch search-multi-search-template,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-msearch-template search-rank-eval,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rank-eval -search-request-body,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-body.html search-search,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search search-shards,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-shards -search-template,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html +search-template,https://www.elastic.co/docs/solutions/search/search-templates search-template-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-template search-terms-enum,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-terms-enum search-validate,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-validate-query search-vector-tile-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-mvt -searchable-snapshots,https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots.html +searchable-snapshots,https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/searchable-snapshots searchable-snapshots-api-cache-stats,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-searchable-snapshots-cache-stats searchable-snapshots-api-clear-cache,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-searchable-snapshots-clear-cache searchable-snapshots-api-mount-snapshot,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-searchable-snapshots-mount searchable-snapshots-api-stats,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-searchable-snapshots-stats searchable-snapshots-apis,https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-searchable_snapshots -search-templates,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html -secure-settings,https://www.elastic.co/guide/en/elasticsearch/reference/current/secure-settings.html +search-templates,https://www.elastic.co/docs/solutions/search/search-templates +secure-settings,https://www.elastic.co/docs/deploy-manage/security/secure-settings security-api-activate-user-profile,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-activate-user-profile security-api-authenticate,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-authenticate security-api-bulk-delete-role,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-bulk-delete-role @@ -792,21 +790,21 @@ security-api-cross-cluster-key-update,https://www.elastic.co/docs/api/doc/elasti security-api-update-key,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-update-api-key security-api-update-user-data,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-update-user-profile-data security-api-update-settings,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-update-settings -security-application-privileges,https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html#application-privileges -security-encrypt-http,https://www.elastic.co/guide/en/elasticsearch/reference/current/security-basic-setup-https.html#encrypt-http-communication -security-encrypt-internode,https://www.elastic.co/guide/en/elasticsearch/reference/current/security-basic-setup.html#encrypt-internode-communication -security-privileges,https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html -security-saml-guide,https://www.elastic.co/guide/en/elasticsearch/reference/current/saml-guide-stack.html -security-settings-api-keys,https://www.elastic.co/guide/en/elasticsearch/reference/current/security-settings.html#api-key-service-settings -security-settings-hashing,https://www.elastic.co/guide/en/elasticsearch/reference/current/security-settings.html#hashing-settings -security-user-cache,https://www.elastic.co/guide/en/elasticsearch/reference/current/controlling-user-cache.html -service-accounts,https://www.elastic.co/guide/en/elasticsearch/reference/current/service-accounts.html -set-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/set-processor.html -shape,https://www.elastic.co/guide/en/elasticsearch/reference/current/shape.html -shard-request-cache,https://www.elastic.co/guide/en/elasticsearch/reference/current/shard-request-cache.html +security-application-privileges,https://www.elastic.co/docs/reference/elasticsearch/security-privileges#application-privileges +security-encrypt-http,https://www.elastic.co/docs/deploy-manage/security/set-up-basic-security-plus-https#encrypt-http-communication +security-encrypt-internode,https://www.elastic.co/docs/deploy-manage/security/set-up-basic-security#encrypt-internode-communication +security-privileges,https://www.elastic.co/docs/reference/elasticsearch/security-privileges +security-saml-guide,https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/saml +security-settings-api-keys,https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/security-settings#api-key-service-settings +security-settings-hashing,https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/security-settings#hashing-settings +security-user-cache,https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-user-cache +service-accounts,https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/service-accounts +set-processor,https://www.elastic.co/docs/reference/enrich-processor/set-processor +shape,https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/shape +shard-request-cache,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/shard-request-cache simulate-ingest-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-simulate-ingest simulate-pipeline-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-simulate -slice-scroll,https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#slice-scroll +slice-scroll,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#slice-scroll slm-api-delete-policy,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-delete-lifecycle slm-api-execute-lifecycle,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-execute-lifecycle slm-api-execute-retention,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-execute-retention @@ -817,7 +815,7 @@ slm-api-put-policy,https://www.elastic.co/docs/api/doc/elasticsearch/operation/o slm-api-start,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-start slm-api-stop,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-stop snapshot-clone,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-clone -snapshot-create,https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-take-snapshot.html +snapshot-create,https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/create-snapshots snapshot-create-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-create snapshot-delete,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-delete snapshot-get,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-get @@ -830,21 +828,21 @@ snapshot-repo-get,https://www.elastic.co/docs/api/doc/elasticsearch/operation/op snapshot-repo-verify,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-verify-repository snapshot-repo-verify-integrity,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-repository-verify-integrity snapshot-restore-amend-replacement,https://docs.oracle.com/javase/8/docs/api/java/util/regex/Matcher.html#appendReplacement-java.lang.StringBuffer-java.lang.String- -snapshot-restore-feature-state,https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshot-restore.html#feature-state -sort-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-processor.html -sort-search-results,https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html -sort-tiebreaker,https://www.elastic.co/guide/en/elasticsearch/reference/current/eql.html#eql-search-specify-a-sort-tiebreaker -source-filtering,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-fields.html#source-filtering -split-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/split-processor.html +snapshot-restore-feature-state,https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore#feature-state +sort-processor,https://www.elastic.co/docs/reference/enrich-processor/sort-processor +sort-search-results,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results +sort-tiebreaker,https://www.elastic.co/docs/explore-analyze/query-filter/languages/eql#eql-search-specify-a-sort-tiebreaker +source-filtering,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#source-filtering +split-processor,https://www.elastic.co/docs/reference/enrich-processor/split-processor sql-async-search-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-get-async sql-async-status-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-get-async-status sql-clear-cursor-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-clear-cursor sql-delete-async-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-delete-async -sql-rest-columnar,https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-rest-columnar.html -sql-rest-filtering,https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-rest-filtering.html -sql-rest-format,https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-rest-format.html +sql-rest-columnar,https://www.elastic.co/docs/explore-analyze/query-filter/languages/sql-rest-columnar +sql-rest-filtering,https://www.elastic.co/docs/explore-analyze/query-filter/languages/sql-rest-filtering +sql-rest-format,https://www.elastic.co/docs/explore-analyze/query-filter/languages/sql-rest-format sql-search-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-query -sql-spec,https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-spec.html +sql-spec,https://www.elastic.co/docs/reference/query-languages/sql/sql-spec sql-translate-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-translate start-basic,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-post-start-basic start-dfanalytics,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-start-data-frame-analytics @@ -854,39 +852,40 @@ start-trial,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operatio stop-dfanalytics,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-stop-data-frame-analytics stop-trained-model-deployment,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-stop-trained-model-deployment stop-transform,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-stop-transform -stored-fields,https://www.elastic.co/guide/en/elasticsearch/reference/current/search-fields.html#stored-fields +stored-fields,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#stored-fields synonym-rule-create,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-put-synonym-rule synonym-rule-delete,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-delete-synonym-rule synonym-rule-get,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-get-synonym-rule synonym-set-create,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-put-synonym -synonym-set-define,https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-synonym-graph-tokenfilter.html#analysis-synonym-graph-define-synonyms +synonym-set-define,https://www.elastic.co/docs/reference/text-analysis/analysis-synonym-graph-tokenfilter#analysis-synonym-graph-define-synonyms synonym-set-delete,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-delete-synonym synonym-set-get,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-get-synonym synonym-set-list,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-get-synonym -supported-flags,https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html#supported-flags +synonym-solr,https://www.elastic.co/docs/reference/text-analysis/analysis-synonym-graph-tokenfilter#_solr_format_2 +supported-flags,https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-simple-query-string-query#supported-flags tasks,https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks -templating-role-query,https://www.elastic.co/guide/en/elasticsearch/reference/current/field-and-document-access-control.html#templating-role-query -terminate-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/terminate-processor.html +templating-role-query,https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level#templating-role-query +terminate-processor,https://www.elastic.co/docs/reference/enrich-processor/terminate-processor test-grok-pattern,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-text-structure-test-grok-pattern time-value,https://github.com/elastic/elasticsearch/blob/current/libs/core/src/main/java/org/elasticsearch/core/TimeValue.java time-zone-id,https://docs.oracle.com/javase/8/docs/api/java/time/ZoneId.html -trim-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/trim-processor.html +trim-processor,https://www.elastic.co/docs/reference/enrich-processor/trim-processor update-dfanalytics,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-data-frame-analytics update-desired-nodes,https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-cluster update-license,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-post update-trained-model-deployment,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-trained-model-deployment update-transform,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-update-transform upgrade-transforms,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-upgrade-transforms -uppercase-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/uppercase-processor.html -urldecode-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/urldecode-processor.html +uppercase-processor,https://www.elastic.co/docs/reference/enrich-processor/uppercase-processor +urldecode-processor,https://www.elastic.co/docs/reference/enrich-processor/urldecode-processor usage-api,https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-xpack -user-agent-processor,https://www.elastic.co/guide/en/elasticsearch/reference/current/user-agent-processor.html -user-profile,https://www.elastic.co/guide/en/elasticsearch/reference/current/user-profile.html -verify-repository,https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-register-repository.html#snapshots-repository-verification +user-agent-processor,https://www.elastic.co/docs/reference/enrich-processor/user-agent-processor +user-profile,https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/user-profiles +verify-repository,https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/self-managed#snapshots-repository-verification voting-config-exclusions,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-post-voting-config-exclusions voyageai-embeddings,https://docs.voyageai.com/docs/embeddings voyageai-rerank,https://docs.voyageai.com/docs/reranker -watcher-works,https://www.elastic.co/guide/en/elasticsearch/reference/current/how-watcher-works.html +watcher-works,https://www.elastic.co/docs/explore-analyze/alerts-cases/watcher/how-watcher-works watcher-api-ack-watch,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-ack-watch watcher-api-activate-watch,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-activate-watch watcher-api-deactivate-watch,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-deactivate-watch @@ -903,4 +902,4 @@ watcher-api-update-settings,https://www.elastic.co/docs/api/doc/elasticsearch/op watsonx-api-keys,https://cloud.ibm.com/iam/apikeys watsonx-api-models,https://www.ibm.com/products/watsonx-ai/foundation-models watsonx-api-version,https://cloud.ibm.com/apidocs/watsonx-ai#active-version-dates -xpack-rollup,https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-rollup.html +xpack-rollup,https://www.elastic.co/docs/manage-data/lifecycle/rollup diff --git a/specification/_types/aggregations/bucket.ts b/specification/_types/aggregations/bucket.ts index 88c6238ca9..d7291c3790 100644 --- a/specification/_types/aggregations/bucket.ts +++ b/specification/_types/aggregations/bucket.ts @@ -1158,8 +1158,9 @@ export class CategorizeTextAggregation extends Aggregation { categorization_filters?: string[] /** * The categorization analyzer specifies how the text is analyzed and tokenized before being categorized. - * The syntax is very similar to that used to define the analyzer in the [Analyze endpoint](https://www.elastic.co/guide/en/elasticsearch/reference/8.0/indices-analyze.html). This property - * cannot be used at the same time as categorization_filters. + * The syntax is very similar to that used to define the analyzer in the analyze API. This property + * cannot be used at the same time as `categorization_filters`. + * @ext_doc_id indices-analyze */ categorization_analyzer?: CategorizeTextAnalyzer /** diff --git a/specification/fleet/msearch/MultiSearchRequest.ts b/specification/fleet/msearch/MultiSearchRequest.ts index 931572dada..77d63a268a 100644 --- a/specification/fleet/msearch/MultiSearchRequest.ts +++ b/specification/fleet/msearch/MultiSearchRequest.ts @@ -115,9 +115,9 @@ export interface Request extends RequestBase { */ wait_for_checkpoints?: Checkpoint[] /** - * If true, returns partial results if there are shard request timeouts or [shard failures](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-replication.html#shard-failures). If false, returns - * an error with no partial results. Defaults to the configured cluster setting `search.default_allow_partial_results` - * which is true by default. + * If true, returns partial results if there are shard request timeouts or shard failures. + * If false, returns an error with no partial results. + * Defaults to the configured cluster setting `search.default_allow_partial_results`, which is true by default. */ allow_partial_search_results?: boolean } diff --git a/specification/fleet/search/SearchRequest.ts b/specification/fleet/search/SearchRequest.ts index 40b57cf64c..a163c1a87e 100644 --- a/specification/fleet/search/SearchRequest.ts +++ b/specification/fleet/search/SearchRequest.ts @@ -130,9 +130,9 @@ export interface Request extends RequestBase { */ wait_for_checkpoints?: Checkpoint[] /** - * If true, returns partial results if there are shard request timeouts or [shard failures](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-replication.html#shard-failures). If false, returns - * an error with no partial results. Defaults to the configured cluster setting `search.default_allow_partial_results` - * which is true by default. + * If true, returns partial results if there are shard request timeouts or shard failures. + * If false, returns an error with no partial results. + * Defaults to the configured cluster setting `search.default_allow_partial_results`, which is true by default. */ allow_partial_search_results?: boolean } diff --git a/specification/nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoRequest.ts b/specification/nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoRequest.ts index 8aeaeaf421..3b867ed28d 100644 --- a/specification/nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoRequest.ts +++ b/specification/nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoRequest.ts @@ -42,7 +42,7 @@ export interface Request extends RequestBase { path_parts: { /** * Comma-separated list of node IDs or names used to limit returned information. - * All the nodes selective options are explained [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes). + * @ext_doc_id cluster-nodes */ node_id: NodeIds } diff --git a/specification/synonyms/_types/SynonymRule.ts b/specification/synonyms/_types/SynonymRule.ts index 99a1c31dcf..891973c207 100644 --- a/specification/synonyms/_types/SynonymRule.ts +++ b/specification/synonyms/_types/SynonymRule.ts @@ -43,7 +43,8 @@ export class SynonymRuleRead implements OverloadOf { */ id: Id /** - * Synonyms, in Solr format, that conform the synonym rule. See https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-synonym-graph-tokenfilter.html#_solr_synonyms_2 + * Synonyms, in Solr format, that conform the synonym rule. + * @ext_doc_id synonym-solr */ synonyms: SynonymString }