diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index ed76c4dd31..36011a7682 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -23094,7 +23094,7 @@ "info" ], "summary": "Get cluster info", - "description": "Get basic build, version, and cluster information.\n\n## Required authorization\n\n* Cluster privileges: `monitor`\n", + "description": "Get basic build, version, and cluster information.\n::: In Serverless, this API is retained for backward compatibility only. Some response fields, such as the version number, should be ignored.\n\n## Required authorization\n\n* Cluster privileges: `monitor`\n", "operationId": "info", "responses": { "200": { @@ -23130,8 +23130,12 @@ }, "examples": { "RootNodeInfoResponseExample1": { - "description": "A successful response from `GET /`s.", - "value": "{\n \"name\": \"instance-0000000000\",\n \"cluster_name\": \"my_test_cluster\",\n \"cluster_uuid\": \"5QaxoN0pRZuOmWSxstBBwQ\",\n \"version\": {\n \"build_date\": \"2024-02-01T13:07:13.727175297Z\",\n \"minimum_wire_compatibility_version\": \"7.17.0\",\n \"build_hash\": \"6185ba65d27469afabc9bc951cded6c17c21e3f3\",\n \"number\": \"8.12.1\",\n \"lucene_version\": \"9.9.2\",\n \"minimum_index_compatibility_version\": \"7.0.0\",\n \"build_flavor\": \"default\",\n \"build_snapshot\": false,\n \"build_type\": \"docker\"\n },\n \"tagline\": \"You Know, for Search\"\n}" + "description": "A successful response from `GET /`.", + "value": "{\n \"name\": \"instance-0000000000\",\n \"cluster_name\": \"my_test_cluster\",\n \"cluster_uuid\": \"zk-HjQtYQGyL3NFSSu7InA\",\n \"version\": {\n \"number\": \"9.1.0\",\n \"build_flavor\": \"default\",\n \"build_type\": \"docker\",\n \"build_hash\": 0,\n \"build_date\": \"2025-07-09T22:10:13.578Z\",\n \"build_snapshot\": false,\n \"lucene_version\": \"10.2.2\",\n \"minimum_wire_compatibility_version\": \"8.19.0\",\n \"minimum_index_compatibility_version\": \"8.0.0\"\n },\n \"tagline\": \"You Know, for Search\"\n}" + }, + "RootNodeInfoResponseExample2": { + "description": "A successful response from `GET /` on Serverless. This API is retained for backward compatibility only. Some fields, such as the version number, return static values and should be ignored.", + "value": "{\n \"name\": \"serverless\",\n \"cluster_name\": \"my_test_serverless_cluster\",\n \"cluster_uuid\": \"8xx0pi24Squnf4PFDOAtwg\",\n \"version\": {\n \"number\": \"8.11.0\",\n \"build_flavor\": \"serverless\",\n \"build_type\": \"docker\",\n \"build_hash\": 0,\n \"build_date\": \"2023-10-31T00:00:00.000Z\",\n \"build_snapshot\": false,\n \"lucene_version\": \"9.7.0\",\n \"minimum_wire_compatibility_version\": \"8.11.0\",\n \"minimum_index_compatibility_version\": \"8.11.0\"\n },\n \"tagline\": \"You Know, for Search\"\n}" } } } @@ -90413,7 +90417,7 @@ "$ref": "#/components/schemas/_types.VersionString" }, "number": { - "description": "The Elasticsearch version number.", + "description": "The Elasticsearch version number.\n\n::: IMPORTANT: For Serverless deployments, this static value is always `8.11.0` and is used solely for backward compatibility with legacy clients.\n Serverless environments are versionless and automatically upgraded, so this value can be safely ignored.", "type": "string" } }, diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index a827981352..1ad325696b 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -13736,7 +13736,7 @@ "info" ], "summary": "Get cluster info", - "description": "Get basic build, version, and cluster information.\n\n## Required authorization\n\n* Cluster privileges: `monitor`\n", + "description": "Get basic build, version, and cluster information.\n::: In Serverless, this API is retained for backward compatibility only. Some response fields, such as the version number, should be ignored.\n\n## Required authorization\n\n* Cluster privileges: `monitor`\n", "operationId": "info", "responses": { "200": { @@ -13772,8 +13772,12 @@ }, "examples": { "RootNodeInfoResponseExample1": { - "description": "A successful response from `GET /`s.", - "value": "{\n \"name\": \"instance-0000000000\",\n \"cluster_name\": \"my_test_cluster\",\n \"cluster_uuid\": \"5QaxoN0pRZuOmWSxstBBwQ\",\n \"version\": {\n \"build_date\": \"2024-02-01T13:07:13.727175297Z\",\n \"minimum_wire_compatibility_version\": \"7.17.0\",\n \"build_hash\": \"6185ba65d27469afabc9bc951cded6c17c21e3f3\",\n \"number\": \"8.12.1\",\n \"lucene_version\": \"9.9.2\",\n \"minimum_index_compatibility_version\": \"7.0.0\",\n \"build_flavor\": \"default\",\n \"build_snapshot\": false,\n \"build_type\": \"docker\"\n },\n \"tagline\": \"You Know, for Search\"\n}" + "description": "A successful response from `GET /`.", + "value": "{\n \"name\": \"instance-0000000000\",\n \"cluster_name\": \"my_test_cluster\",\n \"cluster_uuid\": \"zk-HjQtYQGyL3NFSSu7InA\",\n \"version\": {\n \"number\": \"9.1.0\",\n \"build_flavor\": \"default\",\n \"build_type\": \"docker\",\n \"build_hash\": 0,\n \"build_date\": \"2025-07-09T22:10:13.578Z\",\n \"build_snapshot\": false,\n \"lucene_version\": \"10.2.2\",\n \"minimum_wire_compatibility_version\": \"8.19.0\",\n \"minimum_index_compatibility_version\": \"8.0.0\"\n },\n \"tagline\": \"You Know, for Search\"\n}" + }, + "RootNodeInfoResponseExample2": { + "description": "A successful response from `GET /` on Serverless. This API is retained for backward compatibility only. Some fields, such as the version number, return static values and should be ignored.", + "value": "{\n \"name\": \"serverless\",\n \"cluster_name\": \"my_test_serverless_cluster\",\n \"cluster_uuid\": \"8xx0pi24Squnf4PFDOAtwg\",\n \"version\": {\n \"number\": \"8.11.0\",\n \"build_flavor\": \"serverless\",\n \"build_type\": \"docker\",\n \"build_hash\": 0,\n \"build_date\": \"2023-10-31T00:00:00.000Z\",\n \"build_snapshot\": false,\n \"lucene_version\": \"9.7.0\",\n \"minimum_wire_compatibility_version\": \"8.11.0\",\n \"minimum_index_compatibility_version\": \"8.11.0\"\n },\n \"tagline\": \"You Know, for Search\"\n}" } } } @@ -57735,7 +57739,7 @@ "$ref": "#/components/schemas/_types.VersionString" }, "number": { - "description": "The Elasticsearch version number.", + "description": "The Elasticsearch version number.\n\n::: IMPORTANT: For Serverless deployments, this static value is always `8.11.0` and is used solely for backward compatibility with legacy clients.\n Serverless environments are versionless and automatically upgraded, so this value can be safely ignored.", "type": "string" } }, diff --git a/output/schema/schema.json b/output/schema/schema.json index 4eef88269d..68c4d42a14 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -11046,7 +11046,7 @@ "stability": "stable" } }, - "description": "Get cluster info.\nGet basic build, version, and cluster information.", + "description": "Get cluster info.\nGet basic build, version, and cluster information.\n::: In Serverless, this API is retained for backward compatibility only. Some response fields, such as the version number, should be ignored.", "docId": "api-root", "docTag": "info", "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-info", @@ -32150,7 +32150,7 @@ "body": { "kind": "no_body" }, - "description": "Get cluster info.\nGet basic build, version, and cluster information.", + "description": "Get cluster info.\nGet basic build, version, and cluster information.\n::: In Serverless, this API is retained for backward compatibility only. Some response fields, such as the version number, should be ignored.", "examples": { "RootNodeInfoRequestExample1": { "alternatives": [ @@ -32194,7 +32194,7 @@ }, "path": [], "query": [], - "specLocation": "_global/info/RootNodeInfoRequest.ts#L22-L39" + "specLocation": "_global/info/RootNodeInfoRequest.ts#L22-L40" }, { "kind": "response", @@ -32263,8 +32263,14 @@ }, "examples": { "RootNodeInfoResponseExample1": { - "description": "A successful response from `GET /`s.", - "value": "{\n \"name\": \"instance-0000000000\",\n \"cluster_name\": \"my_test_cluster\",\n \"cluster_uuid\": \"5QaxoN0pRZuOmWSxstBBwQ\",\n \"version\": {\n \"build_date\": \"2024-02-01T13:07:13.727175297Z\",\n \"minimum_wire_compatibility_version\": \"7.17.0\",\n \"build_hash\": \"6185ba65d27469afabc9bc951cded6c17c21e3f3\",\n \"number\": \"8.12.1\",\n \"lucene_version\": \"9.9.2\",\n \"minimum_index_compatibility_version\": \"7.0.0\",\n \"build_flavor\": \"default\",\n \"build_snapshot\": false,\n \"build_type\": \"docker\"\n },\n \"tagline\": \"You Know, for Search\"\n}" + "description": "A successful response from `GET /`.", + "summary": "Stack response", + "value": "{\n \"name\": \"instance-0000000000\",\n \"cluster_name\": \"my_test_cluster\",\n \"cluster_uuid\": \"zk-HjQtYQGyL3NFSSu7InA\",\n \"version\": {\n \"number\": \"9.1.0\",\n \"build_flavor\": \"default\",\n \"build_type\": \"docker\",\n \"build_hash\": 0,\n \"build_date\": \"2025-07-09T22:10:13.578Z\",\n \"build_snapshot\": false,\n \"lucene_version\": \"10.2.2\",\n \"minimum_wire_compatibility_version\": \"8.19.0\",\n \"minimum_index_compatibility_version\": \"8.0.0\"\n },\n \"tagline\": \"You Know, for Search\"\n}" + }, + "RootNodeInfoResponseExample2": { + "description": "A successful response from `GET /` on Serverless. This API is retained for backward compatibility only. Some fields, such as the version number, return static values and should be ignored.", + "summary": "Serverless response", + "value": "{\n \"name\": \"serverless\",\n \"cluster_name\": \"my_test_serverless_cluster\",\n \"cluster_uuid\": \"8xx0pi24Squnf4PFDOAtwg\",\n \"version\": {\n \"number\": \"8.11.0\",\n \"build_flavor\": \"serverless\",\n \"build_type\": \"docker\",\n \"build_hash\": 0,\n \"build_date\": \"2023-10-31T00:00:00.000Z\",\n \"build_snapshot\": false,\n \"lucene_version\": \"9.7.0\",\n \"minimum_wire_compatibility_version\": \"8.11.0\",\n \"minimum_index_compatibility_version\": \"8.11.0\"\n },\n \"tagline\": \"You Know, for Search\"\n}" } }, "name": { @@ -51328,7 +51334,7 @@ } }, { - "description": "The Elasticsearch version number.", + "description": "The Elasticsearch version number.\n\n::: IMPORTANT: For Serverless deployments, this static value is always `8.11.0` and is used solely for backward compatibility with legacy clients.\n Serverless environments are versionless and automatically upgraded, so this value can be safely ignored.", "name": "number", "required": true, "type": { @@ -51340,7 +51346,7 @@ } } ], - "specLocation": "_types/Base.ts#L76-L115" + "specLocation": "_types/Base.ts#L76-L118" }, { "kind": "interface", @@ -51395,7 +51401,7 @@ } } ], - "specLocation": "_types/Base.ts#L117-L125" + "specLocation": "_types/Base.ts#L120-L128" }, { "kind": "interface", @@ -51584,7 +51590,7 @@ } } ], - "specLocation": "_types/Base.ts#L127-L136" + "specLocation": "_types/Base.ts#L130-L139" }, { "kind": "enum", @@ -53366,7 +53372,7 @@ } } ], - "specLocation": "_types/Base.ts#L138-L140" + "specLocation": "_types/Base.ts#L141-L143" }, { "kind": "interface", @@ -57511,7 +57517,7 @@ } } ], - "specLocation": "_types/Base.ts#L142-L145" + "specLocation": "_types/Base.ts#L145-L148" }, { "kind": "interface", diff --git a/specification/_global/info/RootNodeInfoRequest.ts b/specification/_global/info/RootNodeInfoRequest.ts index 23ba4478a9..5efb702c84 100644 --- a/specification/_global/info/RootNodeInfoRequest.ts +++ b/specification/_global/info/RootNodeInfoRequest.ts @@ -22,6 +22,7 @@ import { RequestBase } from '@_types/Base' /** * Get cluster info. * Get basic build, version, and cluster information. + * ::: In Serverless, this API is retained for backward compatibility only. Some response fields, such as the version number, should be ignored. * @rest_spec_name info * @availability stack stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/_global/info/examples/response/RootNodeInfoResponseExample1.yaml b/specification/_global/info/examples/response/RootNodeInfoResponseExample1.yaml index f3fa2ba844..025314f23b 100644 --- a/specification/_global/info/examples/response/RootNodeInfoResponseExample1.yaml +++ b/specification/_global/info/examples/response/RootNodeInfoResponseExample1.yaml @@ -1,19 +1,19 @@ -# summary: '' -description: A successful response from `GET /`s. +summary: Stack response +description: A successful response from `GET /`. # type: response # response_code: 200 value: name: instance-0000000000 cluster_name: my_test_cluster - cluster_uuid: 5QaxoN0pRZuOmWSxstBBwQ + cluster_uuid: zk-HjQtYQGyL3NFSSu7InA 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 + number: 9.1.0 build_flavor: default - build_snapshot: false build_type: docker + build_hash: 00000000 + build_date: 2025-07-09T22:10:13.578182715Z + build_snapshot: false + lucene_version: 10.2.2 + minimum_wire_compatibility_version: 8.19.0 + minimum_index_compatibility_version: 8.0.0 tagline: 'You Know, for Search' diff --git a/specification/_global/info/examples/response/RootNodeInfoResponseExample2.yaml b/specification/_global/info/examples/response/RootNodeInfoResponseExample2.yaml new file mode 100644 index 0000000000..cd5c4f2fee --- /dev/null +++ b/specification/_global/info/examples/response/RootNodeInfoResponseExample2.yaml @@ -0,0 +1,19 @@ +summary: Serverless response +description: A successful response from `GET /` on Serverless. This API is retained for backward compatibility only. Some fields, such as the version number, return static values and should be ignored. +# type: response +# response_code: 200 +value: + name: serverless + cluster_name: my_test_serverless_cluster + cluster_uuid: 8xx0pi24Squnf4PFDOAtwg + version: + number: 8.11.0 + build_flavor: serverless + build_type: docker + build_hash: 00000000 + build_date: 2023-10-31 + build_snapshot: false + lucene_version: 9.7.0 + minimum_wire_compatibility_version: 8.11.0 + minimum_index_compatibility_version: 8.11.0 + tagline: 'You Know, for Search' diff --git a/specification/_types/Base.ts b/specification/_types/Base.ts index 8bb72f17e4..fd67514614 100644 --- a/specification/_types/Base.ts +++ b/specification/_types/Base.ts @@ -110,6 +110,9 @@ export class ElasticsearchVersionInfo { minimum_wire_compatibility_version: VersionString /** * The Elasticsearch version number. + * + * ::: IMPORTANT: For Serverless deployments, this static value is always `8.11.0` and is used solely for backward compatibility with legacy clients. + * Serverless environments are versionless and automatically upgraded, so this value can be safely ignored. */ number: string }