From 85abf468d97c55cc03d188ea5d0db27edb647d6c Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Mon, 3 Mar 2025 09:18:34 -0800 Subject: [PATCH] Replace broken master links (#3858) (cherry picked from commit 96fb0719f53bd2f289639d9c5dc682ca96fd7c5c) --- README.md | 2 +- .../elasticsearch-shared-overlays.yaml | 2 +- output/schema/schema.json | 42 +++++++++++-------- specification/_doc_ids/table.csv | 7 ++++ .../IndicesMigrateToDataStreamRequest.ts | 1 + .../IndicesModifyDataStreamRequest.ts | 1 + .../IndicesPromoteDataStreamRequest.ts | 1 + .../put_alias/IndicesPutAliasRequest.ts | 1 + .../IndicesPutDataLifecycleRequest.ts | 1 + .../IndicesPutIndexTemplateRequest.ts | 1 + .../IndicesUpdateAliasesRequest.ts | 1 + .../IndicesValidateQueryRequest.ts | 1 + 12 files changed, 42 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 57ca6e7696..08e5e2a9dc 100644 --- a/README.md +++ b/README.md @@ -151,7 +151,7 @@ endpoint of Elasticsearch and the respective type mapping. For example: "application/json" ], "description": "Creates or updates a document in an index.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html", "name": "index", "request": { "name": "Request", diff --git a/docs/overlays/elasticsearch-shared-overlays.yaml b/docs/overlays/elasticsearch-shared-overlays.yaml index cf2ec479cf..a47b04e283 100644 --- a/docs/overlays/elasticsearch-shared-overlays.yaml +++ b/docs/overlays/elasticsearch-shared-overlays.yaml @@ -174,7 +174,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/master/modules-scripting.html + url: https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html - name: search x-displayName: Search - name: search_application diff --git a/output/schema/schema.json b/output/schema/schema.json index 1f01a5bbca..d9b0e1483c 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -7945,8 +7945,9 @@ } }, "description": "Convert an index alias to a data stream.\nConverts an index alias to a data stream.\nYou must have a matching index template that is data stream enabled.\nThe alias must meet the following criteria:\nThe alias must have a write index;\nAll indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type;\nThe alias must not have any filters;\nThe alias must not use custom routing.\nIf successful, the request removes the alias and creates a data stream with the same name.\nThe indices for the alias become hidden backing indices for the stream.\nThe write index for the alias becomes the write index for the stream.", + "docId": "data-stream-migrate", "docTag": "data stream", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-migrate-to-data-stream", "name": "indices.migrate_to_data_stream", "privileges": { "index": [ @@ -7986,8 +7987,9 @@ } }, "description": "Update data streams.\nPerforms one or more data stream modification actions in a single atomic operation.", + "docId": "data-stream-update", "docTag": "data stream", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-modify-data-stream", "name": "indices.modify_data_stream", "request": { "name": "Request", @@ -8061,8 +8063,9 @@ } }, "description": "Promote a data stream.\nPromote a data stream from a replicated data stream managed by cross-cluster replication (CCR) to a regular data stream.\n\nWith CCR auto following, a data stream from a remote cluster can be replicated to the local cluster.\nThese data streams can't be rolled over in the local cluster.\nThese replicated data streams roll over only if the upstream data stream rolls over.\nIn the event that the remote cluster is no longer available, the data stream in the local cluster can be promoted to a regular data stream, which allows these data streams to be rolled over in the local cluster.\n\nNOTE: When promoting a data stream, ensure the local cluster has a data stream enabled index template that matches the data stream.\nIf this is missing, the data stream will not be able to roll over until a matching index template is created.\nThis will affect the lifecycle management of the data stream and interfere with the data stream size and retention.", + "docId": "data-stream-promote", "docTag": "data stream", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-promote-data-stream", "name": "indices.promote_data_stream", "request": { "name": "Request", @@ -8096,7 +8099,8 @@ } }, "description": "Create or update an alias.\nAdds a data stream or index to an alias.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", + "docId": "alias-update", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-put-alias", "name": "indices.put_alias", "request": { "name": "Request", @@ -8142,8 +8146,9 @@ } }, "description": "Update data stream lifecycles.\nUpdate the data stream lifecycle of the specified data streams.", + "docId": "data-stream-put-lifecycle", "docTag": "data stream", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-put-lifecycle.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-put-data-lifecycle", "name": "indices.put_data_lifecycle", "request": { "name": "Request", @@ -8181,7 +8186,8 @@ } }, "description": "Create or update an index template.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.\n\nElasticsearch applies templates to new indices based on an wildcard pattern that matches the index name.\nIndex templates are applied during data stream or index creation.\nFor data streams, these settings and mappings are applied when the stream's backing indices are created.\nSettings and mappings specified in a create index API request override any settings or mappings specified in an index template.\nChanges to index templates do not affect existing indices, including the existing backing indices of a data stream.\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**Multiple matching templates**\n\nIf multiple index templates match the name of a new index or data stream, the template with the highest priority is used.\n\nMultiple templates with overlapping index patterns at the same priority are not allowed and an error will be thrown when attempting to create a template matching an existing index template at identical priorities.\n\n**Composing aliases, mappings, and settings**\n\nWhen multiple component templates are specified in the `composed_of` field for an index template, they are merged in the order specified, meaning that later component templates override earlier component templates.\nAny mappings, settings, or aliases from the parent index template are merged in next.\nFinally, any configuration on the index request itself is merged.\nMapping definitions are merged recursively, which means that later mapping components can introduce new field mappings and update the mapping configuration.\nIf a field mapping is already contained in an earlier component, its definition will be completely overwritten by the later one.\nThis recursive merging strategy applies not only to field mappings, but also root options like `dynamic_templates` and `meta`.\nIf an earlier component contains a `dynamic_templates` block, then by default new `dynamic_templates` entries are appended onto the end.\nIf an entry already exists with the same key, then it is overwritten by the new definition.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-template.html", + "docId": "index-templates-put", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-put-index-template", "name": "indices.put_index_template", "privileges": { "cluster": [ @@ -9004,7 +9010,8 @@ } }, "description": "Create or update an alias.\nAdds a data stream or index to an alias.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html", + "docId": "aliases-update", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-update-aliases", "name": "indices.update_aliases", "request": { "name": "Request", @@ -9042,7 +9049,8 @@ } }, "description": "Validate a query.\nValidates a query without running it.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html", + "docId": "search-validate", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-validate.html", "name": "indices.validate_query", "request": { "name": "Request", @@ -138691,7 +138699,7 @@ } } ], - "specLocation": "indices/migrate_to_data_stream/IndicesMigrateToDataStreamRequest.ts#L24-L65" + "specLocation": "indices/migrate_to_data_stream/IndicesMigrateToDataStreamRequest.ts#L24-L66" }, { "kind": "response", @@ -138820,7 +138828,7 @@ }, "path": [], "query": [], - "specLocation": "indices/modify_data_stream/IndicesModifyDataStreamRequest.ts#L23-L44" + "specLocation": "indices/modify_data_stream/IndicesModifyDataStreamRequest.ts#L23-L45" }, { "kind": "response", @@ -139040,7 +139048,7 @@ } } ], - "specLocation": "indices/promote_data_stream/IndicesPromoteDataStreamRequest.ts#L24-L57" + "specLocation": "indices/promote_data_stream/IndicesPromoteDataStreamRequest.ts#L24-L58" }, { "kind": "response", @@ -139193,7 +139201,7 @@ } } ], - "specLocation": "indices/put_alias/IndicesPutAliasRequest.ts#L25-L102" + "specLocation": "indices/put_alias/IndicesPutAliasRequest.ts#L25-L103" }, { "kind": "response", @@ -139326,7 +139334,7 @@ } } ], - "specLocation": "indices/put_data_lifecycle/IndicesPutDataLifecycleRequest.ts#L25-L92" + "specLocation": "indices/put_data_lifecycle/IndicesPutDataLifecycleRequest.ts#L25-L93" }, { "kind": "response", @@ -139421,7 +139429,7 @@ } } ], - "specLocation": "indices/put_index_template/IndicesPutIndexTemplateRequest.ts#L158-L180" + "specLocation": "indices/put_index_template/IndicesPutIndexTemplateRequest.ts#L159-L181" }, { "kind": "request", @@ -139626,7 +139634,7 @@ } } ], - "specLocation": "indices/put_index_template/IndicesPutIndexTemplateRequest.ts#L37-L156" + "specLocation": "indices/put_index_template/IndicesPutIndexTemplateRequest.ts#L37-L157" }, { "kind": "response", @@ -146231,7 +146239,7 @@ } } ], - "specLocation": "indices/update_aliases/IndicesUpdateAliasesRequest.ts#L24-L58" + "specLocation": "indices/update_aliases/IndicesUpdateAliasesRequest.ts#L24-L59" }, { "kind": "response", @@ -146507,7 +146515,7 @@ } } ], - "specLocation": "indices/validate_query/IndicesValidateQueryRequest.ts#L25-L122" + "specLocation": "indices/validate_query/IndicesValidateQueryRequest.ts#L25-L123" }, { "kind": "response", diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv index 89703222a6..b5fc1bda5b 100644 --- a/specification/_doc_ids/table.csv +++ b/specification/_doc_ids/table.csv @@ -1,5 +1,7 @@ apis,https://www.elastic.co/docs/api/doc/elasticsearch/v8 add-nodes,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/add-elasticsearch-nodes.html +alias-update,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-put-alias +aliases-update,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-update-aliases analysis-analyzers,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis-analyzers.html analysis-charfilters,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis-charfilters.html analysis-normalizers,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis-normalizers.html @@ -138,7 +140,11 @@ data-stream-get,https://www.elastic.co/guide/en/elasticsearch/reference/{branch} data-stream-get-lifecycle,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/data-streams-get-lifecycle.html data-stream-lifecycle-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/data-streams-get-lifecycle-stats.html data-stream-path-param,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-create-data-stream.html#indices-create-data-stream-api-path-params +data-stream-migrate,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-migrate-to-data-stream +data-stream-promote,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-promote-data-stream +data-stream-put-lifecycle,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-put-data-lifecycle data-stream-stats-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/data-stream-stats-api.html +data-stream-update,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-modify-data-stream data-streams,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/data-streams.html date-index-name-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/date-index-name-processor.html dcg,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html#_discounted_cumulative_gain_dcg @@ -261,6 +267,7 @@ indexing-buffer,https://www.elastic.co/guide/en/elasticsearch/reference/{branch} index-modules-merge,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-modules-merge.html index-templates,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-templates.html index-templates-exist,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-exists-index-template +index-templates-put,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-put-index-template 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 diff --git a/specification/indices/migrate_to_data_stream/IndicesMigrateToDataStreamRequest.ts b/specification/indices/migrate_to_data_stream/IndicesMigrateToDataStreamRequest.ts index d549144a6f..2aecf81b32 100644 --- a/specification/indices/migrate_to_data_stream/IndicesMigrateToDataStreamRequest.ts +++ b/specification/indices/migrate_to_data_stream/IndicesMigrateToDataStreamRequest.ts @@ -38,6 +38,7 @@ import { Duration } from '@_types/Time' * @availability serverless stability=stable visibility=public * @index_privileges manage * @doc_tag data stream + * @doc_id data-stream-migrate */ export interface Request extends RequestBase { urls: [ diff --git a/specification/indices/modify_data_stream/IndicesModifyDataStreamRequest.ts b/specification/indices/modify_data_stream/IndicesModifyDataStreamRequest.ts index 96e3b7ef87..245477fce6 100644 --- a/specification/indices/modify_data_stream/IndicesModifyDataStreamRequest.ts +++ b/specification/indices/modify_data_stream/IndicesModifyDataStreamRequest.ts @@ -27,6 +27,7 @@ import { Action } from './types' * @availability stack since=7.16.0 stability=stable * @availability serverless stability=stable visibility=public * @doc_tag data stream + * @doc_id data-stream-update */ export interface Request extends RequestBase { urls: [ diff --git a/specification/indices/promote_data_stream/IndicesPromoteDataStreamRequest.ts b/specification/indices/promote_data_stream/IndicesPromoteDataStreamRequest.ts index d4bba25cc5..906d3510d7 100644 --- a/specification/indices/promote_data_stream/IndicesPromoteDataStreamRequest.ts +++ b/specification/indices/promote_data_stream/IndicesPromoteDataStreamRequest.ts @@ -36,6 +36,7 @@ import { Duration } from '@_types/Time' * @rest_spec_name indices.promote_data_stream * @availability stack since=7.9.0 stability=stable * @doc_tag data stream + * @doc_id data-stream-promote */ export interface Request extends RequestBase { urls: [ diff --git a/specification/indices/put_alias/IndicesPutAliasRequest.ts b/specification/indices/put_alias/IndicesPutAliasRequest.ts index 208789db93..ffd0593739 100644 --- a/specification/indices/put_alias/IndicesPutAliasRequest.ts +++ b/specification/indices/put_alias/IndicesPutAliasRequest.ts @@ -28,6 +28,7 @@ import { Duration } from '@_types/Time' * @rest_spec_name indices.put_alias * @availability stack stability=stable * @availability serverless stability=stable visibility=public + * @doc_id alias-update */ export interface Request extends RequestBase { urls: [ diff --git a/specification/indices/put_data_lifecycle/IndicesPutDataLifecycleRequest.ts b/specification/indices/put_data_lifecycle/IndicesPutDataLifecycleRequest.ts index 03e188b672..d81f648db4 100644 --- a/specification/indices/put_data_lifecycle/IndicesPutDataLifecycleRequest.ts +++ b/specification/indices/put_data_lifecycle/IndicesPutDataLifecycleRequest.ts @@ -29,6 +29,7 @@ import { Duration } from '@_types/Time' * @availability stack since=8.11.0 stability=stable * @availability serverless stability=stable visibility=public * @doc_tag data stream + * @doc_id data-stream-put-lifecycle */ export interface Request extends RequestBase { urls: [ diff --git a/specification/indices/put_index_template/IndicesPutIndexTemplateRequest.ts b/specification/indices/put_index_template/IndicesPutIndexTemplateRequest.ts index e921634fc1..866fde01f4 100644 --- a/specification/indices/put_index_template/IndicesPutIndexTemplateRequest.ts +++ b/specification/indices/put_index_template/IndicesPutIndexTemplateRequest.ts @@ -67,6 +67,7 @@ import { Duration } from '@_types/Time' * @availability stack since=7.9.0 stability=stable * @availability serverless stability=stable visibility=public * @cluster_privileges manage_index_templates + * @doc_id index-templates-put */ export interface Request extends RequestBase { urls: [ diff --git a/specification/indices/update_aliases/IndicesUpdateAliasesRequest.ts b/specification/indices/update_aliases/IndicesUpdateAliasesRequest.ts index 0e94ca2787..d0c6f0e1fa 100644 --- a/specification/indices/update_aliases/IndicesUpdateAliasesRequest.ts +++ b/specification/indices/update_aliases/IndicesUpdateAliasesRequest.ts @@ -27,6 +27,7 @@ import { Action } from './types' * @rest_spec_name indices.update_aliases * @availability stack since=1.3.0 stability=stable * @availability serverless stability=stable visibility=public + * @doc_id aliases-update */ export interface Request extends RequestBase { urls: [ diff --git a/specification/indices/validate_query/IndicesValidateQueryRequest.ts b/specification/indices/validate_query/IndicesValidateQueryRequest.ts index 6798c3390a..789ee7244f 100644 --- a/specification/indices/validate_query/IndicesValidateQueryRequest.ts +++ b/specification/indices/validate_query/IndicesValidateQueryRequest.ts @@ -28,6 +28,7 @@ import { Operator } from '@_types/query_dsl/Operator' * @rest_spec_name indices.validate_query * @availability stack since=1.3.0 stability=stable * @availability serverless stability=stable visibility=public + * @doc_id search-validate */ export interface Request extends RequestBase { urls: [