Skip to content

Commit 85195d9

Browse files
authored
[8.x] [DOCS] Fix overlay for resolve cluster (#3670) (#3682)
1 parent 7f7efce commit 85195d9

File tree

5 files changed

+22
-14
lines changed

5 files changed

+22
-14
lines changed

docs/overlays/elasticsearch-openapi-overlays.yaml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -258,16 +258,6 @@ actions:
258258
examples:
259259
nodesInfoResponseExample1:
260260
$ref: "../../specification/nodes/info/examples/200_response/nodesInfoResponseExample1.yaml"
261-
- target: "$.paths['/_resolve/cluster/{name}']['get']"
262-
description: "Add examples for resolve cluster operation"
263-
update:
264-
responses:
265-
200:
266-
content:
267-
application/json:
268-
examples:
269-
resolveClusterResponseExample1:
270-
$ref: "../../specification/indices/resolve_cluster/examples/200_response/ResolveClusterResponseExample1.yaml"
271261
## Examples for connectors
272262
- target: "$.paths['/_connector/_sync_job/{connector_sync_job_id}/_error']['put']"
273263
description: "Add examples for connector job sync error operation"
@@ -501,6 +491,16 @@ actions:
501491
examples:
502492
getIndicesRecoveryResponseExample1:
503493
$ref: "../../specification/indices/recovery/examples/200_response/indicesRecoveryResponseExample1.yaml"
494+
- target: "$.components['responses']['indices.resolve_cluster#200']"
495+
description: "Add examples for resolve cluster operation"
496+
update:
497+
content:
498+
application/json:
499+
examples:
500+
resolveClusterResponseExample1:
501+
$ref: "../../specification/indices/resolve_cluster/examples/200_response/ResolveClusterResponseExample1.yaml"
502+
resolveClusterResponseExample2:
503+
$ref: "../../specification/indices/resolve_cluster/examples/200_response/ResolveClusterResponseExample2.yaml"
504504
- target: "$.components['requestBodies']['indices.shrink']"
505505
description: "Add example for shrink index request"
506506
update:

output/openapi/elasticsearch-openapi.json

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

specification/cluster/remote_info/ClusterRemoteInfoResponse.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,6 @@ export class ClusterRemoteProxyInfo {
7878
num_proxy_sockets_connected: integer
7979
/** The maximum number of socket connections to the remote cluster when proxy mode is configured. */
8080
max_proxy_socket_connections: integer
81-
/** 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. */
81+
/** 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. */
8282
cluster_credentials?: string
8383
}

0 commit comments

Comments
 (0)