From f117a18e322024afada2b091c8725daec9afb5de Mon Sep 17 00:00:00 2001 From: lcawl Date: Fri, 6 Jun 2025 16:50:36 -0700 Subject: [PATCH 1/2] Remove hard-coded links --- specification/_doc_ids/table.csv | 3 ++- specification/_types/aggregations/bucket.ts | 3 ++- .../remote_info/ClusterRemoteInfoRequest.ts | 2 +- specification/fleet/msearch/MultiSearchRequest.ts | 15 +++++++++------ specification/fleet/search/SearchRequest.ts | 3 ++- .../GetRepositoriesMeteringInfoRequest.ts | 3 ++- 6 files changed, 18 insertions(+), 11 deletions(-) diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv index 030e33a1fa..5ff4fbffeb 100644 --- a/specification/_doc_ids/table.csv +++ b/specification/_doc_ids/table.csv @@ -290,7 +290,7 @@ index-templates-put,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operati index-templates-v1,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-templates-v1.html indices-aliases,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-aliases.html indices-aliases-exist,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-exists-alias -indices-analyze,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-analyze.html +indices-analyze,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-analyze indices-clearcache,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-clearcache.html indices-clone-index,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-clone-index.html indices-close,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-close.html @@ -795,6 +795,7 @@ security-user-cache,https://www.elastic.co/guide/en/elasticsearch/reference/{bra service-accounts,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/service-accounts.html set-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/set-processor.html shape,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/shape.html +shard-failures,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-replication.html#shard-failures shard-request-cache,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/shard-request-cache.html simulate-ingest-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/simulate-ingest-api.html simulate-pipeline-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/simulate-pipeline-api.html diff --git a/specification/_types/aggregations/bucket.ts b/specification/_types/aggregations/bucket.ts index 2b2bea3a1d..9ad73a0424 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 + * The syntax is very similar to that used to define the analyzer in the `_analyze` endpoint. This property * cannot be used at the same time as categorization_filters. + * @ext_doc_id indices-analyze */ categorization_analyzer?: CategorizeTextAnalyzer /** diff --git a/specification/cluster/remote_info/ClusterRemoteInfoRequest.ts b/specification/cluster/remote_info/ClusterRemoteInfoRequest.ts index bce879205d..83d8fa7ae3 100644 --- a/specification/cluster/remote_info/ClusterRemoteInfoRequest.ts +++ b/specification/cluster/remote_info/ClusterRemoteInfoRequest.ts @@ -29,7 +29,7 @@ import { RequestBase } from '@_types/Base' * > This API returns information that reflects current state on the local cluster. * > 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. * > Elasticsearch does not spontaneously try to reconnect to a disconnected remote cluster. - * > 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). + * > To trigger a reconnection, attempt a cross-cluster search, ES|QL cross-cluster search, or try the `/_resolve/cluster` endpoint. * @rest_spec_name cluster.remote_info * @availability stack since=6.1.0 stability=stable * @cluster_privileges monitor diff --git a/specification/fleet/msearch/MultiSearchRequest.ts b/specification/fleet/msearch/MultiSearchRequest.ts index db599b3e81..46280f6cb4 100644 --- a/specification/fleet/msearch/MultiSearchRequest.ts +++ b/specification/fleet/msearch/MultiSearchRequest.ts @@ -29,14 +29,16 @@ import { RequestItem } from '@global/msearch/types' import { Checkpoint } from '../_types/Checkpoints' /** - * Executes several [fleet searches](https://www.elastic.co/guide/en/elasticsearch/reference/current/fleet-search.html) with a single API request. - * The API follows the same structure as the [multi search](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html) API. However, similar to the fleet search API, it - * supports the wait_for_checkpoints parameter. + * Executes several fleet searches with a single API request. + * + * The API follows the same structure as the multi search (`_msearch`) API. + * However, similar to the fleet search API, it supports the `wait_for_checkpoints` parameter. * @rest_spec_name fleet.msearch * @availability stack since=7.16.0 stability=experimental * @availability serverless stability=experimental visibility=private * @index_privileges read * @doc_id fleet-multi-search + * @ext_doc_id search-multi-search */ export interface Request extends RequestBase { urls: [ @@ -114,9 +116,10 @@ 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. + * @ext_doc_id shard-failures */ allow_partial_search_results?: boolean } diff --git a/specification/fleet/search/SearchRequest.ts b/specification/fleet/search/SearchRequest.ts index bf6e82d57a..6c9b78ff4d 100644 --- a/specification/fleet/search/SearchRequest.ts +++ b/specification/fleet/search/SearchRequest.ts @@ -131,9 +131,10 @@ 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 + * 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. + * @ext_doc_id shard-failures */ 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..7efa1d3363 100644 --- a/specification/nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoRequest.ts +++ b/specification/nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoRequest.ts @@ -42,7 +42,8 @@ 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). + * For more information about the nodes selective options, refer to the node specification documentation. + * @ext_doc_id cluster-nodes */ node_id: NodeIds } From 2222dde52233132aac2704281cbfd03190b89069 Mon Sep 17 00:00:00 2001 From: lcawl Date: Fri, 6 Jun 2025 16:51:42 -0700 Subject: [PATCH 2/2] Generate output --- output/openapi/elasticsearch-openapi.json | 36 ++++++++++++------ output/schema/schema.json | 46 ++++++++++++++--------- 2 files changed, 52 insertions(+), 30 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 571906b704..0448399162 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -4918,7 +4918,7 @@ "cluster" ], "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).", + "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.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-cross-cluster-search.html" }, @@ -10658,8 +10658,11 @@ "tags": [ "fleet" ], - "summary": "Executes several [fleet searches](https://www.elastic.co/guide/en/elasticsearch/reference/current/fleet-search.html) with a single API request", - "description": "The API follows the same structure as the [multi search](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html) API. However, similar to the fleet search API, it\nsupports the wait_for_checkpoints parameter.", + "summary": "Executes several fleet searches with a single API request", + "description": "The API follows the same structure as the multi search (`_msearch`) API.\nHowever, similar to the fleet search API, it supports the `wait_for_checkpoints` parameter.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html" + }, "operationId": "fleet-msearch", "parameters": [ { @@ -10716,8 +10719,11 @@ "tags": [ "fleet" ], - "summary": "Executes several [fleet searches](https://www.elastic.co/guide/en/elasticsearch/reference/current/fleet-search.html) with a single API request", - "description": "The API follows the same structure as the [multi search](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html) API. However, similar to the fleet search API, it\nsupports the wait_for_checkpoints parameter.", + "summary": "Executes several fleet searches with a single API request", + "description": "The API follows the same structure as the multi search (`_msearch`) API.\nHowever, similar to the fleet search API, it supports the `wait_for_checkpoints` parameter.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html" + }, "operationId": "fleet-msearch-1", "parameters": [ { @@ -10776,8 +10782,11 @@ "tags": [ "fleet" ], - "summary": "Executes several [fleet searches](https://www.elastic.co/guide/en/elasticsearch/reference/current/fleet-search.html) with a single API request", - "description": "The API follows the same structure as the [multi search](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html) API. However, similar to the fleet search API, it\nsupports the wait_for_checkpoints parameter.", + "summary": "Executes several fleet searches with a single API request", + "description": "The API follows the same structure as the multi search (`_msearch`) API.\nHowever, similar to the fleet search API, it supports the `wait_for_checkpoints` parameter.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html" + }, "operationId": "fleet-msearch-2", "parameters": [ { @@ -10837,8 +10846,11 @@ "tags": [ "fleet" ], - "summary": "Executes several [fleet searches](https://www.elastic.co/guide/en/elasticsearch/reference/current/fleet-search.html) with a single API request", - "description": "The API follows the same structure as the [multi search](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html) API. However, similar to the fleet search API, it\nsupports the wait_for_checkpoints parameter.", + "summary": "Executes several fleet searches with a single API request", + "description": "The API follows the same structure as the multi search (`_msearch`) API.\nHowever, similar to the fleet search API, it supports the `wait_for_checkpoints` parameter.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html" + }, "operationId": "fleet-msearch-3", "parameters": [ { @@ -28065,7 +28077,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.\nFor more information about the nodes selective options, refer to the node specification documentation.", "required": true, "deprecated": false, "schema": { @@ -108227,7 +108239,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" @@ -108664,7 +108676,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. 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.", "deprecated": false, "schema": { "type": "boolean" diff --git a/output/schema/schema.json b/output/schema/schema.json index 217e339c3f..3b5a09d204 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -2800,7 +2800,7 @@ "stability": "stable" } }, - "description": "Get remote cluster information.\n\nGet 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).", + "description": "Get remote cluster information.\n\nGet 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.", "docId": "cluster-remote-info", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-remote-info.html", "extDocId": "modules-cross-cluster-search", @@ -5454,9 +5454,11 @@ "stability": "experimental" } }, - "description": "Executes several [fleet searches](https://www.elastic.co/guide/en/elasticsearch/reference/current/fleet-search.html) with a single API request.\nThe API follows the same structure as the [multi search](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html) API. However, similar to the fleet search API, it\nsupports the wait_for_checkpoints parameter.", + "description": "Executes several fleet searches with a single API request.\n\nThe API follows the same structure as the multi search (`_msearch`) API.\nHowever, similar to the fleet search API, it supports the `wait_for_checkpoints` parameter.", "docId": "fleet-multi-search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/fleet-multi-search.html", + "extDocId": "search-multi-search", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-multi-search.html", "name": "fleet.msearch", "privileges": { "index": [ @@ -6374,7 +6376,7 @@ }, "description": "Get tokens from text analysis.\nThe 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.", "docId": "indices-analyze", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-analyze.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-analyze", "extDocId": "analysis", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis.html", "name": "indices.analyze", @@ -58728,7 +58730,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` endpoint. This property\ncannot be used at the same time as categorization_filters.", + "extDocId": "indices-analyze", + "extDocUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-analyze", "name": "categorization_analyzer", "required": false, "type": { @@ -58789,7 +58793,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L1117-L1182" + "specLocation": "_types/aggregations/bucket.ts#L1117-L1183" }, { "kind": "type_alias", @@ -58801,7 +58805,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": [ @@ -59477,7 +59481,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L1189-L1193" + "specLocation": "_types/aggregations/bucket.ts#L1190-L1194" }, { "kind": "interface", @@ -60890,7 +60894,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L1240-L1267" + "specLocation": "_types/aggregations/bucket.ts#L1241-L1268" }, { "kind": "interface", @@ -60990,7 +60994,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L1226-L1238" + "specLocation": "_types/aggregations/bucket.ts#L1227-L1239" }, { "kind": "enum", @@ -62772,7 +62776,7 @@ } } ], - "specLocation": "_types/aggregations/bucket.ts#L1195-L1224" + "specLocation": "_types/aggregations/bucket.ts#L1196-L1225" }, { "kind": "interface", @@ -116718,7 +116722,7 @@ "body": { "kind": "no_body" }, - "description": "Get remote cluster information.\n\nGet 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).", + "description": "Get remote cluster information.\n\nGet 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.", "inherits": { "type": { "name": "RequestBase", @@ -128814,7 +128818,7 @@ } } }, - "description": "Executes several [fleet searches](https://www.elastic.co/guide/en/elasticsearch/reference/current/fleet-search.html) with a single API request.\nThe API follows the same structure as the [multi search](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html) API. However, similar to the fleet search API, it\nsupports the wait_for_checkpoints parameter.", + "description": "Executes several fleet searches with a single API request.\n\nThe API follows the same structure as the multi search (`_msearch`) API.\nHowever, similar to the fleet search API, it supports the `wait_for_checkpoints` parameter.", "inherits": { "type": { "name": "RequestBase", @@ -129008,7 +129012,9 @@ } }, { - "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.", + "extDocId": "shard-failures", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-replication.html#shard-failures", "name": "allow_partial_search_results", "required": false, "type": { @@ -129020,7 +129026,7 @@ } } ], - "specLocation": "fleet/msearch/MultiSearchRequest.ts#L31-L125" + "specLocation": "fleet/msearch/MultiSearchRequest.ts#L31-L128" }, { "kind": "response", @@ -130051,7 +130057,9 @@ } }, { - "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. 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.", + "extDocId": "shard-failures", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-replication.html#shard-failures", "name": "allow_partial_search_results", "required": false, "type": { @@ -130063,7 +130071,7 @@ } } ], - "specLocation": "fleet/search/SearchRequest.ts#L55-L267" + "specLocation": "fleet/search/SearchRequest.ts#L55-L268" }, { "kind": "response", @@ -198525,7 +198533,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.\nFor more information about the nodes selective options, refer to the node specification documentation.", + "extDocId": "cluster-nodes", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster.html#cluster-nodes", "name": "node_id", "required": true, "type": { @@ -198538,7 +198548,7 @@ } ], "query": [], - "specLocation": "nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoRequest.ts#L23-L49" + "specLocation": "nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoRequest.ts#L23-L50" }, { "kind": "response",