Skip to content

Commit f117a18

Browse files
committed
Remove hard-coded links
1 parent 27bef8e commit f117a18

File tree

6 files changed

+18
-11
lines changed

6 files changed

+18
-11
lines changed

specification/_doc_ids/table.csv

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,7 @@ index-templates-put,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operati
290290
index-templates-v1,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-templates-v1.html
291291
indices-aliases,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-aliases.html
292292
indices-aliases-exist,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-exists-alias
293-
indices-analyze,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-analyze.html
293+
indices-analyze,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-analyze
294294
indices-clearcache,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-clearcache.html
295295
indices-clone-index,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-clone-index.html
296296
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
795795
service-accounts,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/service-accounts.html
796796
set-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/set-processor.html
797797
shape,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/shape.html
798+
shard-failures,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-replication.html#shard-failures
798799
shard-request-cache,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/shard-request-cache.html
799800
simulate-ingest-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/simulate-ingest-api.html
800801
simulate-pipeline-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/simulate-pipeline-api.html

specification/_types/aggregations/bucket.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1158,8 +1158,9 @@ export class CategorizeTextAggregation extends Aggregation {
11581158
categorization_filters?: string[]
11591159
/**
11601160
* The categorization analyzer specifies how the text is analyzed and tokenized before being categorized.
1161-
* 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
1161+
* The syntax is very similar to that used to define the analyzer in the `_analyze` endpoint. This property
11621162
* cannot be used at the same time as categorization_filters.
1163+
* @ext_doc_id indices-analyze
11631164
*/
11641165
categorization_analyzer?: CategorizeTextAnalyzer
11651166
/**

specification/cluster/remote_info/ClusterRemoteInfoRequest.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ import { RequestBase } from '@_types/Base'
2929
* > This API returns information that reflects current state on the local cluster.
3030
* > 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.
3131
* > Elasticsearch does not spontaneously try to reconnect to a disconnected remote cluster.
32-
* > 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).
32+
* > To trigger a reconnection, attempt a cross-cluster search, ES|QL cross-cluster search, or try the `/_resolve/cluster` endpoint.
3333
* @rest_spec_name cluster.remote_info
3434
* @availability stack since=6.1.0 stability=stable
3535
* @cluster_privileges monitor

specification/fleet/msearch/MultiSearchRequest.ts

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,16 @@ import { RequestItem } from '@global/msearch/types'
2929
import { Checkpoint } from '../_types/Checkpoints'
3030

3131
/**
32-
* Executes several [fleet searches](https://www.elastic.co/guide/en/elasticsearch/reference/current/fleet-search.html) with a single API request.
33-
* 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
34-
* supports the wait_for_checkpoints parameter.
32+
* Executes several fleet searches with a single API request.
33+
*
34+
* The API follows the same structure as the multi search (`_msearch`) API.
35+
* However, similar to the fleet search API, it supports the `wait_for_checkpoints` parameter.
3536
* @rest_spec_name fleet.msearch
3637
* @availability stack since=7.16.0 stability=experimental
3738
* @availability serverless stability=experimental visibility=private
3839
* @index_privileges read
3940
* @doc_id fleet-multi-search
41+
* @ext_doc_id search-multi-search
4042
*/
4143
export interface Request extends RequestBase {
4244
urls: [
@@ -114,9 +116,10 @@ export interface Request extends RequestBase {
114116
*/
115117
wait_for_checkpoints?: Checkpoint[]
116118
/**
117-
* 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
118-
* an error with no partial results. Defaults to the configured cluster setting `search.default_allow_partial_results`
119-
* which is true by default.
119+
* If true, returns partial results if there are shard request timeouts or shard failures.
120+
* If false, returns an error with no partial results.
121+
* Defaults to the configured cluster setting `search.default_allow_partial_results` which is true by default.
122+
* @ext_doc_id shard-failures
120123
*/
121124
allow_partial_search_results?: boolean
122125
}

specification/fleet/search/SearchRequest.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,9 +131,10 @@ export interface Request extends RequestBase {
131131
*/
132132
wait_for_checkpoints?: Checkpoint[]
133133
/**
134-
* 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
134+
* If true, returns partial results if there are shard request timeouts or shard failures. If false, returns
135135
* an error with no partial results. Defaults to the configured cluster setting `search.default_allow_partial_results`
136136
* which is true by default.
137+
* @ext_doc_id shard-failures
137138
*/
138139
allow_partial_search_results?: boolean
139140
}

specification/nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoRequest.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,8 @@ export interface Request extends RequestBase {
4242
path_parts: {
4343
/**
4444
* Comma-separated list of node IDs or names used to limit returned information.
45-
* All the nodes selective options are explained [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes).
45+
* For more information about the nodes selective options, refer to the node specification documentation.
46+
* @ext_doc_id cluster-nodes
4647
*/
4748
node_id: NodeIds
4849
}

0 commit comments

Comments
 (0)