[DOCS] Add link for cluster settings (#4491)

lcawl · lcawl · commit 6faef71cb027 · 2025-06-09T09:10:35.000-07:00
(cherry picked from commit 93cbe0b)
diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json
diff --git a/output/schema/schema.json b/output/schema/schema.json
diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv
@@ -850,6 +850,7 @@ sql-rest-format,https://www.elastic.co/docs/explore-analyze/query-filter/languag
 sql-search-api,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-sql-query
 sql-spec,https://www.elastic.co/docs/reference/query-languages/sql/sql-spec
 sql-translate-api,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-sql-translate
+stack-settings,https://www.elastic.co/docs/deploy-manage/stack-settings
 start-basic,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-license-post-start-basic
 start-dfanalytics,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-start-data-frame-analytics
 start-trained-model-deployment,https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-start-trained-model-deployment
diff --git a/specification/cluster/get_settings/ClusterGetSettingsRequest.ts b/specification/cluster/get_settings/ClusterGetSettingsRequest.ts
@@ -28,6 +28,7 @@ import { Duration } from '@_types/Time'
  * @availability serverless stability=stable visibility=private
  * @cluster_privileges monitor
  * @doc_id cluster-get-settings
+ * @ext_doc_id stack-settings
  */
 export interface Request extends RequestBase {
   urls: [
diff --git a/specification/cluster/get_settings/ClusterGetSettingsResponse.ts b/specification/cluster/get_settings/ClusterGetSettingsResponse.ts
@@ -22,8 +22,11 @@ import { UserDefinedValue } from '@spec_utils/UserDefinedValue'
 
 export class Response {
   body: {
+    /** The settings that persist after the cluster restarts. */
     persistent: Dictionary<string, UserDefinedValue>
+    /** The settings that do not persist after the cluster restarts. */
     transient: Dictionary<string, UserDefinedValue>
+    /** The default setting values. */
     defaults?: Dictionary<string, UserDefinedValue>
   }
 }
diff --git a/specification/cluster/put_settings/ClusterPutSettingsRequest.ts b/specification/cluster/put_settings/ClusterPutSettingsRequest.ts
@@ -46,6 +46,7 @@ import { UserDefinedValue } from '@spec_utils/UserDefinedValue'
  * @availability stack stability=stable
  * @availability serverless stability=stable visibility=private
  * @doc_id cluster-update-settings
+ * @ext_doc_id stack-settings
  */
 export interface Request extends RequestBase {
   urls: [
@@ -62,7 +63,9 @@ export interface Request extends RequestBase {
     timeout?: Duration
   }
   body: {
+    /** The settings that persist after the cluster restarts. */
     persistent?: Dictionary<string, UserDefinedValue>
+    /** The settings that do not persist after the cluster restarts. */
     transient?: Dictionary<string, UserDefinedValue>
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -22,8 +22,11 @@ import { UserDefinedValue } from '@spec_utils/UserDefinedValue'`
`22`	`22`
`23`	`23`	`export class Response {`
`24`	`24`	`body: {`
	`25`	`+ /** The settings that persist after the cluster restarts. */`
`25`	`26`	`persistent: Dictionary<string, UserDefinedValue>`
	`27`	`+ /** The settings that do not persist after the cluster restarts. */`
`26`	`28`	`transient: Dictionary<string, UserDefinedValue>`
	`29`	`+ /** The default setting values. */`
`27`	`30`	`defaults?: Dictionary<string, UserDefinedValue>`
`28`	`31`	`}`
`29`	`32`	`}`
Original file line number	Diff line number	Diff line change
`@@ -46,6 +46,7 @@ import { UserDefinedValue } from '@spec_utils/UserDefinedValue'`
`46`	`46`	`* @availability stack stability=stable`
`47`	`47`	`* @availability serverless stability=stable visibility=private`
`48`	`48`	`* @doc_id cluster-update-settings`
	`49`	`+ * @ext_doc_id stack-settings`
`49`	`50`	`*/`
`50`	`51`	`export interface Request extends RequestBase {`
`51`	`52`	`urls: [`
`@@ -62,7 +63,9 @@ export interface Request extends RequestBase {`
`62`	`63`	`timeout?: Duration`
`63`	`64`	`}`
`64`	`65`	`body: {`
	`66`	`+ /** The settings that persist after the cluster restarts. */`
`65`	`67`	`persistent?: Dictionary<string, UserDefinedValue>`
	`68`	`+ /** The settings that do not persist after the cluster restarts. */`
`66`	`69`	`transient?: Dictionary<string, UserDefinedValue>`
`67`	`70`	`}`
`68`	`71`	`}`