diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index e022d7ead7..585e3cb86a 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -15759,7 +15759,7 @@ "info" ], "summary": "Get cluster info", - "description": "Returns basic information about the cluster.", + "description": "Get basic build, version, and cluster information.", "operationId": "info", "responses": { "200": { @@ -24125,7 +24125,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": { @@ -24136,7 +24136,7 @@ { "in": "path", "name": "max_archive_version", - "description": "Specifies the maximum [archive_version](https://www.elastic.co/guide/en/elasticsearch/reference/current/get-repositories-metering-api.html#get-repositories-metering-api-response-body) to be cleared from the archive.", + "description": "Specifies the maximum `archive_version` to be cleared from the archive.", "required": true, "deprecated": false, "schema": { @@ -71905,15 +71905,19 @@ "$ref": "#/components/schemas/_types:DateTime" }, "build_flavor": { + "description": "The build flavor. For example, `default`.", "type": "string" }, "build_hash": { + "description": "The Elasticsearch Git commit's SHA hash.", "type": "string" }, "build_snapshot": { + "description": "Indicates whether the Elasticsearch build was a snapshot.", "type": "boolean" }, "build_type": { + "description": "The build type that corresponds to how Elasticsearch was installed.\nFor example, `docker`, `rpm`, or `tar`.", "type": "string" }, "lucene_version": { @@ -71926,6 +71930,7 @@ "$ref": "#/components/schemas/_types:VersionString" }, "number": { + "description": "The Elasticsearch version number.", "type": "string" } }, diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 0d411c213b..92f2d863b4 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -9070,7 +9070,7 @@ "info" ], "summary": "Get cluster info", - "description": "Returns basic information about the cluster.", + "description": "Get basic build, version, and cluster information.", "operationId": "info", "responses": { "200": { @@ -46246,15 +46246,19 @@ "$ref": "#/components/schemas/_types:DateTime" }, "build_flavor": { + "description": "The build flavor. For example, `default`.", "type": "string" }, "build_hash": { + "description": "The Elasticsearch Git commit's SHA hash.", "type": "string" }, "build_snapshot": { + "description": "Indicates whether the Elasticsearch build was a snapshot.", "type": "boolean" }, "build_type": { + "description": "The build type that corresponds to how Elasticsearch was installed.\nFor example, `docker`, `rpm`, or `tar`.", "type": "string" }, "lucene_version": { @@ -46267,6 +46271,7 @@ "$ref": "#/components/schemas/_types:VersionString" }, "number": { + "description": "The Elasticsearch version number.", "type": "string" } }, diff --git a/output/schema/schema.json b/output/schema/schema.json index 9fec766617..f34724898b 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -7984,10 +7984,16 @@ } }, "description": "Reload search analyzers.\nReload 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.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-reload-analyzers.html", + "docId": "indices-reload-analyzers", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-reload-analyzers.html", "extDocId": "search-analyzer", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-analyzer.html", "name": "indices.reload_search_analyzers", + "privileges": { + "index": [ + "manage" + ] + }, "request": { "name": "Request", "namespace": "indices.reload_search_analyzers" @@ -8818,9 +8824,15 @@ "stability": "stable" } }, - "description": "Get cluster info.\nReturns basic information about the cluster.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html", + "description": "Get cluster info.\nGet basic build, version, and cluster information.", + "docId": "api-root", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/rest-api-root.html", "name": "info", + "privileges": { + "cluster": [ + "monitor" + ] + }, "request": { "name": "Request", "namespace": "_global.info" @@ -13430,8 +13442,9 @@ } }, "description": "Clear the archived repositories metering.\nClear the archived repositories metering information in the cluster.", + "docId": "clear-repositories-metering-archive-api", "docTag": "cluster", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-repositories-metering-archive-api.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/clear-repositories-metering-archive-api.html", "name": "nodes.clear_repositories_metering_archive", "privileges": { "cluster": [ @@ -13472,8 +13485,9 @@ } }, "description": "Get cluster repositories metering.\nGet repositories metering information for a cluster.\nThis API exposes monotonically non-decreasing counters and it is expected that clients would durably store the information needed to compute aggregations over a period of time.\nAdditionally, the information exposed by this API is volatile, meaning that it will not be present after node restarts.", + "docId": "get-repositories-metering-api", "docTag": "cluster", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-repositories-metering-api.html", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-repositories-metering-api.html", "name": "nodes.get_repositories_metering_info", "privileges": { "cluster": [ @@ -27784,7 +27798,7 @@ "body": { "kind": "no_body" }, - "description": "Get cluster info.\nReturns basic information about the cluster.", + "description": "Get cluster info.\nGet basic build, version, and cluster information.", "inherits": { "type": { "name": "RequestBase", @@ -27797,7 +27811,7 @@ }, "path": [], "query": [], - "specLocation": "_global/info/RootNodeInfoRequest.ts#L22-L29" + "specLocation": "_global/info/RootNodeInfoRequest.ts#L22-L31" }, { "kind": "response", @@ -27805,6 +27819,7 @@ "kind": "properties", "properties": [ { + "description": "The responding cluster's name.", "name": "cluster_name", "required": true, "type": { @@ -27827,6 +27842,7 @@ } }, { + "description": "The responding node's name.", "name": "name", "required": true, "type": { @@ -27849,6 +27865,7 @@ } }, { + "description": "The running version of Elasticsearch.", "name": "version", "required": true, "type": { @@ -27865,7 +27882,7 @@ "name": "Response", "namespace": "_global.info" }, - "specLocation": "_global/info/RootNodeInfoResponse.ts#L23-L31" + "specLocation": "_global/info/RootNodeInfoResponse.ts#L23-L40" }, { "kind": "request", @@ -44642,6 +44659,7 @@ }, "properties": [ { + "description": "The Elasticsearch Git commit's date.", "name": "build_date", "required": true, "type": { @@ -44653,6 +44671,7 @@ } }, { + "description": "The build flavor. For example, `default`.", "name": "build_flavor", "required": true, "type": { @@ -44664,6 +44683,7 @@ } }, { + "description": "The Elasticsearch Git commit's SHA hash.", "name": "build_hash", "required": true, "type": { @@ -44675,6 +44695,7 @@ } }, { + "description": "Indicates whether the Elasticsearch build was a snapshot.", "name": "build_snapshot", "required": true, "type": { @@ -44686,6 +44707,7 @@ } }, { + "description": "The build type that corresponds to how Elasticsearch was installed.\nFor example, `docker`, `rpm`, or `tar`.", "name": "build_type", "required": true, "type": { @@ -44697,6 +44719,7 @@ } }, { + "description": "The version number of Elasticsearch's underlying Lucene software.", "name": "lucene_version", "required": true, "type": { @@ -44708,6 +44731,7 @@ } }, { + "description": "The minimum index version with which the responding node can read from disk.", "name": "minimum_index_compatibility_version", "required": true, "type": { @@ -44719,6 +44743,7 @@ } }, { + "description": "The minimum node version with which the responding node can communicate.\nAlso the minimum version from which you can perform a rolling upgrade.", "name": "minimum_wire_compatibility_version", "required": true, "type": { @@ -44730,6 +44755,7 @@ } }, { + "description": "The Elasticsearch version number.", "name": "number", "required": true, "type": { @@ -44741,7 +44767,7 @@ } } ], - "specLocation": "_types/Base.ts#L54-L64" + "specLocation": "_types/Base.ts#L54-L93" }, { "kind": "interface", @@ -44796,7 +44822,7 @@ } } ], - "specLocation": "_types/Base.ts#L66-L74" + "specLocation": "_types/Base.ts#L95-L103" }, { "kind": "interface", @@ -44973,7 +44999,7 @@ } } ], - "specLocation": "_types/Base.ts#L76-L85" + "specLocation": "_types/Base.ts#L105-L114" }, { "kind": "type_alias", @@ -46638,7 +46664,7 @@ } } ], - "specLocation": "_types/Base.ts#L87-L89" + "specLocation": "_types/Base.ts#L116-L118" }, { "kind": "interface", @@ -50325,7 +50351,7 @@ } } ], - "specLocation": "_types/Base.ts#L91-L94" + "specLocation": "_types/Base.ts#L120-L123" }, { "kind": "interface", @@ -137674,7 +137700,7 @@ } } ], - "specLocation": "indices/reload_search_analyzers/ReloadSearchAnalyzersRequest.ts#L23-L51" + "specLocation": "indices/reload_search_analyzers/ReloadSearchAnalyzersRequest.ts#L23-L53" }, { "kind": "response", @@ -182098,7 +182124,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/{branch}/cluster.html#cluster-nodes", "name": "node_id", "required": true, "type": { @@ -182110,7 +182138,7 @@ } }, { - "description": "Specifies the maximum [archive_version](https://www.elastic.co/guide/en/elasticsearch/reference/current/get-repositories-metering-api.html#get-repositories-metering-api-response-body) to be cleared from the archive.", + "description": "Specifies the maximum `archive_version` to be cleared from the archive.", "name": "max_archive_version", "required": true, "type": { @@ -182123,7 +182151,7 @@ } ], "query": [], - "specLocation": "nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveRequest.ts#L24-L45" + "specLocation": "nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveRequest.ts#L24-L46" }, { "kind": "response", @@ -182141,7 +182169,7 @@ "name": "Response", "namespace": "nodes.clear_repositories_metering_archive" }, - "specLocation": "nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveResponse.ts#L36-L38" + "specLocation": "nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveResponse.ts#L37-L39" }, { "kind": "interface", @@ -182157,7 +182185,9 @@ }, "properties": [ { - "description": "Name of the cluster. Based on the [Cluster name setting](https://www.elastic.co/guide/en/elasticsearch/reference/current/important-settings.html#cluster-name).", + "description": "Name of the cluster. Based on the `cluster.name` setting.", + "extDocId": "cluster-name", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/important-settings.html#cluster-name", "name": "cluster_name", "required": true, "type": { @@ -182192,7 +182222,7 @@ } } ], - "specLocation": "nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveResponse.ts#L25-L34" + "specLocation": "nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveResponse.ts#L25-L35" }, { "kind": "request", @@ -182228,7 +182258,7 @@ } ], "query": [], - "specLocation": "nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoRequest.ts#L23-L42" + "specLocation": "nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoRequest.ts#L23-L43" }, { "kind": "response", @@ -182262,7 +182292,7 @@ }, "properties": [ { - "description": "Name of the cluster. Based on the [Cluster name setting](https://www.elastic.co/guide/en/elasticsearch/reference/current/important-settings.html#cluster-name).", + "description": "Name of the cluster. Based on the `cluster.name` setting.", "name": "cluster_name", "required": true, "type": { diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv index 2dc98b5983..1cd571caf5 100644 --- a/specification/_doc_ids/table.csv +++ b/specification/_doc_ids/table.csv @@ -8,6 +8,7 @@ analysis-tokenizers,https://www.elastic.co/guide/en/elasticsearch/reference/{bra analysis,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis.html analyzer-anatomy,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analyzer-anatomy.html api-date-math-index-names,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/api-conventions.html#api-date-math-index-names +api-root,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/rest-api-root.html append-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/append-processor.html async-search,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/async-search.html attachment,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/attachment.html diff --git a/specification/_global/info/RootNodeInfoRequest.ts b/specification/_global/info/RootNodeInfoRequest.ts index a0d20dd32b..68f9a5e783 100644 --- a/specification/_global/info/RootNodeInfoRequest.ts +++ b/specification/_global/info/RootNodeInfoRequest.ts @@ -21,9 +21,11 @@ import { RequestBase } from '@_types/Base' /** * Get cluster info. - * Returns basic information about the cluster. + * Get basic build, version, and cluster information. * @rest_spec_name info * @availability stack stability=stable * @availability serverless stability=stable visibility=public + * @cluster_privileges monitor + * @doc_id api-root */ export interface Request extends RequestBase {} diff --git a/specification/_global/info/RootNodeInfoResponse.ts b/specification/_global/info/RootNodeInfoResponse.ts index f964454d96..81b565342e 100644 --- a/specification/_global/info/RootNodeInfoResponse.ts +++ b/specification/_global/info/RootNodeInfoResponse.ts @@ -22,10 +22,19 @@ import { Name, Uuid } from '@_types/common' export class Response { body: { + /** + * The responding cluster's name. + */ cluster_name: Name cluster_uuid: Uuid + /** + * The responding node's name. + */ name: Name tagline: string + /** + * The running version of Elasticsearch. + */ version: ElasticsearchVersionInfo } } diff --git a/specification/_global/info/examples/response/RootNodeInfoResponseExample1.yaml b/specification/_global/info/examples/response/RootNodeInfoResponseExample1.yaml new file mode 100644 index 0000000000..f3fa2ba844 --- /dev/null +++ b/specification/_global/info/examples/response/RootNodeInfoResponseExample1.yaml @@ -0,0 +1,19 @@ +# summary: '' +description: A successful response from `GET /`s. +# type: response +# response_code: 200 +value: + name: instance-0000000000 + cluster_name: my_test_cluster + cluster_uuid: 5QaxoN0pRZuOmWSxstBBwQ + version: + build_date: '2024-02-01T13:07:13.727175297Z' + minimum_wire_compatibility_version: 7.17.0 + build_hash: 6185ba65d27469afabc9bc951cded6c17c21e3f3 + number: 8.12.1 + lucene_version: 9.9.2 + minimum_index_compatibility_version: 7.0.0 + build_flavor: default + build_snapshot: false + build_type: docker + tagline: 'You Know, for Search' diff --git a/specification/_types/Base.ts b/specification/_types/Base.ts index 383dab96b3..621087765a 100644 --- a/specification/_types/Base.ts +++ b/specification/_types/Base.ts @@ -52,14 +52,43 @@ export class AcknowledgedResponseBase { export class DynamicResponseBase {} export class ElasticsearchVersionInfo { + /** + * The Elasticsearch Git commit's date. + */ build_date: DateTime + /** + * The build flavor. For example, `default`. + */ build_flavor: string + /** + * The Elasticsearch Git commit's SHA hash. + */ build_hash: string + /** + * Indicates whether the Elasticsearch build was a snapshot. + */ build_snapshot: boolean + /** + * The build type that corresponds to how Elasticsearch was installed. + * For example, `docker`, `rpm`, or `tar`. + */ build_type: string + /** + * The version number of Elasticsearch's underlying Lucene software. + */ lucene_version: VersionString + /** + * The minimum index version with which the responding node can read from disk. + */ minimum_index_compatibility_version: VersionString + /** + * The minimum node version with which the responding node can communicate. + * Also the minimum version from which you can perform a rolling upgrade. + */ minimum_wire_compatibility_version: VersionString + /** + * The Elasticsearch version number. + */ number: string } diff --git a/specification/indices/reload_search_analyzers/ReloadSearchAnalyzersRequest.ts b/specification/indices/reload_search_analyzers/ReloadSearchAnalyzersRequest.ts index c3b7e11439..e022732a63 100644 --- a/specification/indices/reload_search_analyzers/ReloadSearchAnalyzersRequest.ts +++ b/specification/indices/reload_search_analyzers/ReloadSearchAnalyzersRequest.ts @@ -37,6 +37,8 @@ import { ExpandWildcards, Indices } from '@_types/common' * This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future. * @rest_spec_name indices.reload_search_analyzers * @availability stack since=7.3.0 stability=stable + * @index_privileges manage + * @doc_id indices-reload-analyzers * @ext_doc_id search-analyzer */ export interface Request extends RequestBase { diff --git a/specification/indices/reload_search_analyzers/examples/request/ReloadSearchAnalyzersRequestExample1.yaml b/specification/indices/reload_search_analyzers/examples/request/ReloadSearchAnalyzersRequestExample1.yaml new file mode 100644 index 0000000000..bdb0234cb5 --- /dev/null +++ b/specification/indices/reload_search_analyzers/examples/request/ReloadSearchAnalyzersRequestExample1.yaml @@ -0,0 +1,15 @@ +# summary: +# method_request: POST /my-index-000001/_reload_search_analyzers +# description: '' +# type: request +value: + _shards: + total: 2 + successful: 2 + failed: 0 + reload_details: + - index: my-index-000001 + reloaded_analyzers: + - my_synonyms + reloaded_node_ids: + - mfdqTXn_T7SGr2Ho2KT8uw diff --git a/specification/nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveRequest.ts b/specification/nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveRequest.ts index cccf463f54..711d354790 100644 --- a/specification/nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveRequest.ts +++ b/specification/nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveRequest.ts @@ -29,16 +29,17 @@ import { long } from '@_types/Numeric' * @availability serverless stability=experimental visibility=private * @cluster_privileges monitor, manage * @doc_tag cluster + * @doc_id clear-repositories-metering-archive-api */ 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 /** - * Specifies the maximum [archive_version](https://www.elastic.co/guide/en/elasticsearch/reference/current/get-repositories-metering-api.html#get-repositories-metering-api-response-body) to be cleared from the archive. + * Specifies the maximum `archive_version` to be cleared from the archive. */ max_archive_version: long } diff --git a/specification/nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveResponse.ts b/specification/nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveResponse.ts index 5727ecf802..88f04b62c6 100644 --- a/specification/nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveResponse.ts +++ b/specification/nodes/clear_repositories_metering_archive/ClearRepositoriesMeteringArchiveResponse.ts @@ -24,7 +24,8 @@ import { Name } from '@_types/common' export class ResponseBase extends NodesResponseBase { /** - * Name of the cluster. Based on the [Cluster name setting](https://www.elastic.co/guide/en/elasticsearch/reference/current/important-settings.html#cluster-name). + * Name of the cluster. Based on the `cluster.name` setting. + * @ext_doc_id cluster-name */ cluster_name: Name /** diff --git a/specification/nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoRequest.ts b/specification/nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoRequest.ts index ddc35edb75..e626255b8f 100644 --- a/specification/nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoRequest.ts +++ b/specification/nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoRequest.ts @@ -30,6 +30,7 @@ import { NodeIds } from '@_types/common' * @availability serverless stability=experimental visibility=private * @cluster_privileges monitor, manage * @doc_tag cluster + * @doc_id get-repositories-metering-api */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoResponse.ts b/specification/nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoResponse.ts index 5727ecf802..3c5edd03c2 100644 --- a/specification/nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoResponse.ts +++ b/specification/nodes/get_repositories_metering_info/GetRepositoriesMeteringInfoResponse.ts @@ -24,7 +24,7 @@ import { Name } from '@_types/common' export class ResponseBase extends NodesResponseBase { /** - * Name of the cluster. Based on the [Cluster name setting](https://www.elastic.co/guide/en/elasticsearch/reference/current/important-settings.html#cluster-name). + * Name of the cluster. Based on the `cluster.name` setting. */ cluster_name: Name /**