Skip to content

Commit a81526b

Browse files
[DOCS]: Clarify GET / response on Serverless (#4981)
* Add info about version number for serverless Co-authored-by: Liam Thompson <[email protected]>
1 parent bdf1474 commit a81526b

File tree

7 files changed

+66
-29
lines changed

7 files changed

+66
-29
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 8 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/openapi/elasticsearch-serverless-openapi.json

Lines changed: 8 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/schema.json

Lines changed: 17 additions & 11 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/_global/info/RootNodeInfoRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ import { RequestBase } from '@_types/Base'
2222
/**
2323
* Get cluster info.
2424
* Get basic build, version, and cluster information.
25+
* ::: In Serverless, this API is retained for backward compatibility only. Some response fields, such as the version number, should be ignored.
2526
* @rest_spec_name info
2627
* @availability stack stability=stable
2728
* @availability serverless stability=stable visibility=public
Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
# summary: ''
2-
description: A successful response from `GET /`s.
1+
summary: Stack response
2+
description: A successful response from `GET /`.
33
# type: response
44
# response_code: 200
55
value:
66
name: instance-0000000000
77
cluster_name: my_test_cluster
8-
cluster_uuid: 5QaxoN0pRZuOmWSxstBBwQ
8+
cluster_uuid: zk-HjQtYQGyL3NFSSu7InA
99
version:
10-
build_date: '2024-02-01T13:07:13.727175297Z'
11-
minimum_wire_compatibility_version: 7.17.0
12-
build_hash: 6185ba65d27469afabc9bc951cded6c17c21e3f3
13-
number: 8.12.1
14-
lucene_version: 9.9.2
15-
minimum_index_compatibility_version: 7.0.0
10+
number: 9.1.0
1611
build_flavor: default
17-
build_snapshot: false
1812
build_type: docker
13+
build_hash: 00000000
14+
build_date: 2025-07-09T22:10:13.578182715Z
15+
build_snapshot: false
16+
lucene_version: 10.2.2
17+
minimum_wire_compatibility_version: 8.19.0
18+
minimum_index_compatibility_version: 8.0.0
1919
tagline: 'You Know, for Search'
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
summary: Serverless response
2+
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.
3+
# type: response
4+
# response_code: 200
5+
value:
6+
name: serverless
7+
cluster_name: my_test_serverless_cluster
8+
cluster_uuid: 8xx0pi24Squnf4PFDOAtwg
9+
version:
10+
number: 8.11.0
11+
build_flavor: serverless
12+
build_type: docker
13+
build_hash: 00000000
14+
build_date: 2023-10-31
15+
build_snapshot: false
16+
lucene_version: 9.7.0
17+
minimum_wire_compatibility_version: 8.11.0
18+
minimum_index_compatibility_version: 8.11.0
19+
tagline: 'You Know, for Search'

specification/_types/Base.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,9 @@ export class ElasticsearchVersionInfo {
110110
minimum_wire_compatibility_version: VersionString
111111
/**
112112
* The Elasticsearch version number.
113+
*
114+
* ::: IMPORTANT: For Serverless deployments, this static value is always `8.11.0` and is used solely for backward compatibility with legacy clients.
115+
* Serverless environments are versionless and automatically upgraded, so this value can be safely ignored.
113116
*/
114117
number: string
115118
}

0 commit comments

Comments
 (0)