Skip to content

[Backport 8.x] [DOCS] Add overlays for examples inapplicable to serverless #3638

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 26, 2025
Merged

[Backport 8.x] [DOCS] Add overlays for examples inapplicable to serverless #3638

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bd697b5
[DOCS] Add overlays for examples inapplicable to serverless (#3635)
lcawl Jan 28, 2025
dff22a1
Merge branch '8.x' into backport-3635-to-8.x
pquentin Feb 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/overlays/elasticsearch-openapi-overlays.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,15 @@ actions:
examples:
resumeFollowIndexResponseExample1:
$ref: "../../specification/ccr/resume_follow/examples/response/ResumeFollowIndexResponseExample1.yaml"
## Examples for cluster
- target: "$.components['requestBodies']['cluster.allocation_explain']"
description: "Add example for cluster allocation exaplain request"
update:
content:
application/json:
examples:
clusterAllocationExplainRequestExample1:
$ref: "../../specification/cluster/allocation_explain/examples/request/ClusterAllocationExplainRequestExample1.yaml"
- target: "$.paths['/{index}/_ccr/unfollow']['post']"
description: "Add examples for unfollow an index"
update:
Expand Down Expand Up @@ -315,6 +324,8 @@ actions:
examples:
clusterPutSettingsRequestExample1:
$ref: "../../specification/cluster/put_settings/examples/request/ClusterPutSettingsRequestExample1.yaml"
clusterPutSettingsRequestExample2:
$ref: "../../specification/cluster/put_settings/examples/request/ClusterPutSettingsRequestExample2.yaml"
- target: "$.paths['/_cluster/reroute']['post']"
description: "Add examples for cluster reroute operation"
update:
Expand Down
15 changes: 8 additions & 7 deletions output/schema/schema.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions specification/cluster/allocation_explain/ClusterAllocationExplainRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ import { Duration } from '@_types/Time'
* @availability stack since=5.0.0 stability=stable
* @availability serverless stability=stable visibility=private
* @doc_id cluster-allocation-explain
* @doc_tag cluster
*/
export interface Request extends RequestBase {
urls: [
Expand Down
1 change: 1 addition & 0 deletions specification/cluster/health/ClusterHealthRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ import { Duration } from '@_types/Time'

/**
* Get the cluster health status.
*
* You can also use the API to get the health status of only specified data streams and indices.
* For data streams, the API retrieves the health status of the stream’s backing indices.
*
Expand Down
1 change: 1 addition & 0 deletions specification/cluster/put_settings/ClusterPutSettingsRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import { Duration } from '@_types/Time'

/**
* Update the cluster settings.
*
* Configure and update dynamic settings on a running cluster.
* You can also configure dynamic settings locally on an unstarted or shut down node in `elasticsearch.yml`.
*
Expand Down