Skip to content

Commit 12ef6cf

Browse files
github-actions[bot]lcawlpquentin
authored
[DOCS] Add overlays for examples inapplicable to serverless (#3635) (#3638)
(cherry picked from commit 38fde2b) Co-authored-by: Lisa Cawley <[email protected]> Co-authored-by: Quentin Pradet <[email protected]>
1 parent eeeda9a commit 12ef6cf

File tree

5 files changed

+22
-7
lines changed

5 files changed

+22
-7
lines changed

docs/overlays/elasticsearch-openapi-overlays.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,15 @@ actions:
199199
examples:
200200
resumeFollowIndexResponseExample1:
201201
$ref: "../../specification/ccr/resume_follow/examples/response/ResumeFollowIndexResponseExample1.yaml"
202+
## Examples for cluster
203+
- target: "$.components['requestBodies']['cluster.allocation_explain']"
204+
description: "Add example for cluster allocation exaplain request"
205+
update:
206+
content:
207+
application/json:
208+
examples:
209+
clusterAllocationExplainRequestExample1:
210+
$ref: "../../specification/cluster/allocation_explain/examples/request/ClusterAllocationExplainRequestExample1.yaml"
202211
- target: "$.paths['/{index}/_ccr/unfollow']['post']"
203212
description: "Add examples for unfollow an index"
204213
update:
@@ -315,6 +324,8 @@ actions:
315324
examples:
316325
clusterPutSettingsRequestExample1:
317326
$ref: "../../specification/cluster/put_settings/examples/request/ClusterPutSettingsRequestExample1.yaml"
327+
clusterPutSettingsRequestExample2:
328+
$ref: "../../specification/cluster/put_settings/examples/request/ClusterPutSettingsRequestExample2.yaml"
318329
- target: "$.paths['/_cluster/reroute']['post']"
319330
description: "Add examples for cluster reroute operation"
320331
update:

output/schema/schema.json

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

specification/cluster/allocation_explain/ClusterAllocationExplainRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ import { Duration } from '@_types/Time'
3232
* @availability stack since=5.0.0 stability=stable
3333
* @availability serverless stability=stable visibility=private
3434
* @doc_id cluster-allocation-explain
35+
* @doc_tag cluster
3536
*/
3637
export interface Request extends RequestBase {
3738
urls: [

specification/cluster/health/ClusterHealthRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ import { Duration } from '@_types/Time'
3131

3232
/**
3333
* Get the cluster health status.
34+
*
3435
* You can also use the API to get the health status of only specified data streams and indices.
3536
* For data streams, the API retrieves the health status of the stream’s backing indices.
3637
*

specification/cluster/put_settings/ClusterPutSettingsRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ import { Duration } from '@_types/Time'
2424

2525
/**
2626
* Update the cluster settings.
27+
*
2728
* Configure and update dynamic settings on a running cluster.
2829
* You can also configure dynamic settings locally on an unstarted or shut down node in `elasticsearch.yml`.
2930
*

0 commit comments

Comments
 (0)