[8.x] [DOCS] Fix overlay for resolve cluster (#3670) (#3682)

elastic · Jan 31, 2025 · 85195d9 · 85195d9
1 parent 7f7efce
commit 85195d9
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 14 deletions.
diff --git a/docs/overlays/elasticsearch-openapi-overlays.yaml b/docs/overlays/elasticsearch-openapi-overlays.yaml
@@ -258,16 +258,6 @@ actions:
           examples:
             nodesInfoResponseExample1:
               $ref: "../../specification/nodes/info/examples/200_response/nodesInfoResponseExample1.yaml"
-  - target: "$.paths['/_resolve/cluster/{name}']['get']"
-    description: "Add examples for resolve cluster operation"
-    update:      
-      responses:
-        200:
-          content:
-            application/json:
-              examples:
-                resolveClusterResponseExample1:
-                  $ref: "../../specification/indices/resolve_cluster/examples/200_response/ResolveClusterResponseExample1.yaml"
 ## Examples for connectors
   - target: "$.paths['/_connector/_sync_job/{connector_sync_job_id}/_error']['put']"
     description: "Add examples for connector job sync error operation"
@@ -501,6 +491,16 @@ actions:
           examples:
             getIndicesRecoveryResponseExample1:
                   $ref: "../../specification/indices/recovery/examples/200_response/indicesRecoveryResponseExample1.yaml"
+  - target: "$.components['responses']['indices.resolve_cluster#200']"
+    description: "Add examples for resolve cluster operation"
+    update: 
+      content:
+        application/json:
+          examples:
+            resolveClusterResponseExample1:
+              $ref: "../../specification/indices/resolve_cluster/examples/200_response/ResolveClusterResponseExample1.yaml"
+            resolveClusterResponseExample2:
+              $ref: "../../specification/indices/resolve_cluster/examples/200_response/ResolveClusterResponseExample2.yaml"
   - target: "$.components['requestBodies']['indices.shrink']"
     description: "Add example for shrink index request"
     update: 

diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json
diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json
diff --git a/output/schema/schema.json b/output/schema/schema.json
diff --git a/specification/cluster/remote_info/ClusterRemoteInfoResponse.ts b/specification/cluster/remote_info/ClusterRemoteInfoResponse.ts
@@ -78,6 +78,6 @@ export class ClusterRemoteProxyInfo {
   num_proxy_sockets_connected: integer
   /** The maximum number of socket connections to the remote cluster when proxy mode is configured. */
   max_proxy_socket_connections: integer
-  /** This field presents and has value of ::es_redacted:: only when the remote cluster is configured with the API key based model. Otherwise, the field is not present. */
+  /** This field is present and has a value of `::es_redacted::` only when the remote cluster is configured with the API key based model. Otherwise, the field is not present. */
   cluster_credentials?: string
 }