Skip to content

Commit 7c31b5e

Browse files
committed
Add example for root API
1 parent 60cec77 commit 7c31b5e

File tree

8 files changed

+101
-13
lines changed

8 files changed

+101
-13
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 6 additions & 1 deletion
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: 6 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/schema.json

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

specification/_doc_ids/table.csv

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ analysis-tokenizers,https://www.elastic.co/guide/en/elasticsearch/reference/{bra
88
analysis,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis.html
99
analyzer-anatomy,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analyzer-anatomy.html
1010
api-date-math-index-names,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/api-conventions.html#api-date-math-index-names
11+
api-root,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/rest-api-root.html
1112
append-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/append-processor.html
1213
async-search,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/async-search.html
1314
attachment,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/attachment.html

specification/_global/info/RootNodeInfoRequest.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,11 @@ import { RequestBase } from '@_types/Base'
2121

2222
/**
2323
* Get cluster info.
24-
* Returns basic information about the cluster.
24+
* Get basic build, version, and cluster information.
2525
* @rest_spec_name info
2626
* @availability stack stability=stable
2727
* @availability serverless stability=stable visibility=public
28+
* @cluster_privileges monitor
29+
* @doc_id api-root
2830
*/
2931
export interface Request extends RequestBase {}

specification/_global/info/RootNodeInfoResponse.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,19 @@ import { Name, Uuid } from '@_types/common'
2222

2323
export class Response {
2424
body: {
25+
/**
26+
* The responding cluster's name.
27+
*/
2528
cluster_name: Name
2629
cluster_uuid: Uuid
30+
/**
31+
* The responding node's name.
32+
*/
2733
name: Name
2834
tagline: string
35+
/**
36+
* The running version of Elasticsearch.
37+
*/
2938
version: ElasticsearchVersionInfo
3039
}
3140
}
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# summary: ''
2+
description: A successful response from `GET /`s.
3+
# type: response
4+
# response_code: 200
5+
value:
6+
name: instance-0000000000
7+
cluster_name: my_test_cluster
8+
cluster_uuid: 5QaxoN0pRZuOmWSxstBBwQ
9+
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
16+
build_flavor: default
17+
build_snapshot: false
18+
build_type: docker
19+
tagline: 'You Know, for Search'

specification/_types/Base.ts

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,14 +52,43 @@ export class AcknowledgedResponseBase {
5252
export class DynamicResponseBase {}
5353

5454
export class ElasticsearchVersionInfo {
55+
/**
56+
* The Elasticsearch Git commit's date.
57+
*/
5558
build_date: DateTime
59+
/**
60+
* The build flavor. For example, `default`.
61+
*/
5662
build_flavor: string
63+
/**
64+
* The Elasticsearch Git commit's SHA hash.
65+
*/
5766
build_hash: string
67+
/**
68+
* Indicates whether the Elasticsearch build was a snapshot.
69+
*/
5870
build_snapshot: boolean
71+
/**
72+
* The build type that corresponds to how Elasticsearch was installed.
73+
* For example, `docker`, `rpm`, or `tar`.
74+
*/
5975
build_type: string
76+
/**
77+
* The version number of Elasticsearch's underlying Lucene software.
78+
*/
6079
lucene_version: VersionString
80+
/**
81+
* The minimum index version with which the responding node can read from disk.
82+
*/
6183
minimum_index_compatibility_version: VersionString
84+
/**
85+
* The minimum node version with which the responding node can communicate.
86+
* Also the minimum version from which you can perform a rolling upgrade.
87+
*/
6288
minimum_wire_compatibility_version: VersionString
89+
/**
90+
* The Elasticsearch version number.
91+
*/
6392
number: string
6493
}
6594

0 commit comments

Comments
 (0)