From c0470279772bc869e266d23ce540fc6cab7142bf Mon Sep 17 00:00:00 2001 From: pquentin <42327+pquentin@users.noreply.github.com> Date: Wed, 5 Mar 2025 04:06:46 +0000 Subject: [PATCH] Update rest-api-spec --- output/schema/schema-serverless.json | 37 +++++++++++++++++----------- 1 file changed, 22 insertions(+), 15 deletions(-) diff --git a/output/schema/schema-serverless.json b/output/schema/schema-serverless.json index fb2c83b835..5395f79aab 100644 --- a/output/schema/schema-serverless.json +++ b/output/schema/schema-serverless.json @@ -3827,8 +3827,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": [ @@ -3868,8 +3869,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", @@ -3906,7 +3908,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", @@ -3952,8 +3955,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", @@ -3991,7 +3995,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": [ @@ -4411,7 +4416,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", @@ -4449,7 +4455,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", @@ -23361,7 +23368,7 @@ } } ], - "specLocation": "indices/migrate_to_data_stream/IndicesMigrateToDataStreamRequest.ts#L24-L65" + "specLocation": "indices/migrate_to_data_stream/IndicesMigrateToDataStreamRequest.ts#L24-L66" }, { "body": { @@ -23419,7 +23426,7 @@ }, "path": [], "query": [], - "specLocation": "indices/modify_data_stream/IndicesModifyDataStreamRequest.ts#L23-L44" + "specLocation": "indices/modify_data_stream/IndicesModifyDataStreamRequest.ts#L23-L45" }, { "body": { @@ -23576,7 +23583,7 @@ } } ], - "specLocation": "indices/put_alias/IndicesPutAliasRequest.ts#L25-L102" + "specLocation": "indices/put_alias/IndicesPutAliasRequest.ts#L25-L103" }, { "body": { @@ -23709,7 +23716,7 @@ } } ], - "specLocation": "indices/put_data_lifecycle/IndicesPutDataLifecycleRequest.ts#L25-L92" + "specLocation": "indices/put_data_lifecycle/IndicesPutDataLifecycleRequest.ts#L25-L93" }, { "body": { @@ -23932,7 +23939,7 @@ } } ], - "specLocation": "indices/put_index_template/IndicesPutIndexTemplateRequest.ts#L37-L156" + "specLocation": "indices/put_index_template/IndicesPutIndexTemplateRequest.ts#L37-L157" }, { "body": { @@ -25531,7 +25538,7 @@ } } ], - "specLocation": "indices/update_aliases/IndicesUpdateAliasesRequest.ts#L24-L58" + "specLocation": "indices/update_aliases/IndicesUpdateAliasesRequest.ts#L24-L59" }, { "body": { @@ -25753,7 +25760,7 @@ } } ], - "specLocation": "indices/validate_query/IndicesValidateQueryRequest.ts#L25-L122" + "specLocation": "indices/validate_query/IndicesValidateQueryRequest.ts#L25-L123" }, { "body": { @@ -123184,7 +123191,7 @@ } } ], - "specLocation": "indices/put_index_template/IndicesPutIndexTemplateRequest.ts#L158-L180" + "specLocation": "indices/put_index_template/IndicesPutIndexTemplateRequest.ts#L159-L181" }, { "kind": "interface",