Skip to content

Commit 8f6baca

Browse files
authored
[DOCS] Add link for cluster settings (#4491) (#4501)
(cherry picked from commit 93cbe0b)
1 parent e5dfb8a commit 8f6baca

File tree

6 files changed

+31
-3
lines changed

6 files changed

+31
-3
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 11 additions & 0 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: 12 additions & 3 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
@@ -203,6 +203,7 @@ eql-sequences,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/e
203203
eql-missing-events,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql-syntax.html#eql-missing-events
204204
eql-syntax,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql-syntax.html
205205
eql,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql.html
206+
es-settings,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/settings.html
206207
esql,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/esql.html
207208
esql-async-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/esql-async-query-api.html
208209
esql-async-query-delete,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/esql-async-query-delete-api.html

specification/cluster/get_settings/ClusterGetSettingsRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ import { Duration } from '@_types/Time'
2828
* @availability serverless stability=stable visibility=private
2929
* @cluster_privileges monitor
3030
* @doc_id cluster-get-settings
31+
* @ext_doc_id es-settings
3132
*/
3233
export interface Request extends RequestBase {
3334
urls: [

specification/cluster/get_settings/ClusterGetSettingsResponse.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,11 @@ import { UserDefinedValue } from '@spec_utils/UserDefinedValue'
2222

2323
export class Response {
2424
body: {
25+
/** The settings that persist after the cluster restarts. */
2526
persistent: Dictionary<string, UserDefinedValue>
27+
/** The settings that do not persist after the cluster restarts. */
2628
transient: Dictionary<string, UserDefinedValue>
29+
/** The default setting values. */
2730
defaults?: Dictionary<string, UserDefinedValue>
2831
}
2932
}

specification/cluster/put_settings/ClusterPutSettingsRequest.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ import { UserDefinedValue } from '@spec_utils/UserDefinedValue'
4646
* @availability stack stability=stable
4747
* @availability serverless stability=stable visibility=private
4848
* @doc_id cluster-update-settings
49+
* @ext_doc_id es-settings
4950
*/
5051
export interface Request extends RequestBase {
5152
urls: [
@@ -62,7 +63,9 @@ export interface Request extends RequestBase {
6263
timeout?: Duration
6364
}
6465
body: {
66+
/** The settings that persist after the cluster restarts. */
6567
persistent?: Dictionary<string, UserDefinedValue>
68+
/** The settings that do not persist after the cluster restarts. */
6669
transient?: Dictionary<string, UserDefinedValue>
6770
}
6871
}

0 commit comments

Comments
 (0)