Skip to content

[8.x] Adds cluster, graph and ILM API example requests and responses #2932

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.

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
Sep 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
188 changes: 187 additions & 1 deletion docs/overlays/elasticsearch-openapi-overlays.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,190 @@ actions:
examples:
resetFeaturesResponseExample1:
$ref: "../../specification/features/reset_features/ResetFeaturesResponseExample1.json"

- target: "$.components['requestBodies']['cluster.allocation_explain']"
description: "Add examples for cluster allocation explain operation"
update:
content:
application/json:
examples:
clusterAllocationExplainRequestExample1:
$ref: "../../specification/cluster/allocation_explain/clusterAllocationExplainRequestExample1.json"
- target: "$.components['responses']['cluster.health#200']"
description: "Add examples for cluster health operation"
update:
content:
application/json:
examples:
clusterHealthResponseExample1:
$ref: "../../specification/cluster/health/clusterHealthResponseExample1.json"
- target: "$.paths['/_cluster/settings']['put']"
description: "Add examples for cluster update settings operation"
update:
requestBody:
content:
application/json:
examples:
clusterPutSettingsRequestExample1:
$ref: "../../specification/cluster/put_settings/clusterPutSettingsRequestExample1.json"
- target: "$.paths['/_cluster/reroute']['post']"
description: "Add examples for cluster reroute operation"
update:
requestBody:
content:
application/json:
examples:
clusterRerouteRequestExample1:
$ref: "../../specification/cluster/reroute/clusterRerouteRequestExample1.json"
- target: "$.components['requestBodies']['nodes.reload_secure_settings']"
description: "Add examples for nodes reload secure settings operation"
update:
content:
application/json:
examples:
clusterNodesReloadSecureSettingsRequestExample1:
$ref: "../../specification/nodes/reload_secure_settings/clusterNodesReloadSecureSettingsRequestExample1.json"
- target: "$.components['responses']['nodes.reload_secure_settings#200']"
description: "Add response examples for nodes reload secure settings operation"
update:
content:
application/json:
examples:
clusterNodesReloadSecureSettingsResponseExample1:
$ref: "../../specification/nodes/reload_secure_settings/clusterNodesReloadSecureSettingsResponseExample1.json"
- target: "$.paths['/_tasks']['get']"
description: "Add examples for task management operation"
update:
responses:
200:
content:
application/json:
examples:
getTasksResponseExample1:
$ref: "../../specification/tasks/get/getTasksResponseExample1.json"
- target: "$.components['responses']['nodes.info#200']"
description: "Add response examples for nodes info"
update:
content:
application/json:
examples:
nodesInfoResponseExample1:
$ref: "../../specification/nodes/info/nodesInfoResponseExample1.yaml"
- target: "$.paths['/_ilm/policy/{policy}']['delete']"
description: "Add examples for delete lifecycle policy operation"
update:
responses:
200:
content:
application/json:
examples:
deleteLifecycleResponseExample1:
$ref: "../../specification/ilm/delete_lifecycle/DeleteLifecycleResponseExample1.json"
- target: "$.paths['/_ilm/policy/{policy}']['put']"
description: "Add examples for create a lifecycle operation"
update:
update:
requestBody:
content:
application/json:
examples:
putLifecycleRequestExample1:
$ref: "../../specification/ilm/put_lifecycle/PutLifecycleRequestExample1.json"
responses:
200:
content:
application/json:
examples:
putLifecycleResponseExample1:
$ref: "../../specification/ilm/put_lifecycle/PutLifecycleResponseExample1.json"
- target: "$.components['responses']['ilm.get_lifecycle#200']"
description: "Add examples for get lifecycle policy operation"
update:
content:
application/json:
examples:
getLifecycleResponseExample1:
$ref: "../../specification/ilm/get_lifecycle/GetLifecycleResponseExample1.json"
- target: "$.paths['/_ilm/migrate_to_data_tiers']['post']"
description: "Add examples for migrate to data tiers routing operation"
update:
update:
requestBody:
content:
application/json:
examples:
migrateToDataTiersRequestExample1:
$ref: "../../specification/ilm/migrate_to_data_tiers/MigrateToDataTiersRequestExample1.json"
responses:
200:
content:
application/json:
examples:
migrateToDataTiersResponseExample1:
$ref: "../../specification/ilm/migrate_to_data_tiers/MigrateToDataTiersResponseExample1.json"
- target: "$.paths['/_ilm/move/{index}']['post']"
description: "Add examples for move to lifecycle step operation"
update:
update:
requestBody:
content:
application/json:
examples:
moveToStepRequestExample1:
$ref: "../../specification/ilm/move_to_step/MoveToStepRequestExample1.json"
responses:
200:
content:
application/json:
examples:
moveToStepResponseExample1:
$ref: "../../specification/ilm/move_to_step/MoveToStepResponseExample1.json"
- target: "$.paths['/_ilm/start']['post']"
description: "Add examples for start index lifecycle management operation"
update:
responses:
200:
content:
application/json:
examples:
startILMResponseExample1:
$ref: "../../specification/ilm/start/StartILMResponseExample1.json"
- target: "$.paths['/_ilm/stop']['post']"
description: "Add examples for stop index lifecycle management operation"
update:
responses:
200:
content:
application/json:
examples:
stopILMResponseExample1:
$ref: "../../specification/ilm/stop/stopILMResponseExample1.json"
- target: "$.paths['/_ilm/status']['get']"
description: "Add examples for get index lifecycle management status operation"
update:
responses:
200:
content:
application/json:
examples:
getILMStatusResponseExample1:
$ref: "../../specification/ilm/get_status/GetILMStatusResponseExample1.json"
- target: "$.paths['/{index}/_ilm/explain']['get']"
description: "Add examples for explain lifecycle operation"
update:
responses:
200:
content:
application/json:
examples:
explainLifecycleResponseExample1:
$ref: "../../specification/ilm/explain_lifecycle/ExplainLifecycleResponseExample1.json"
- target: "$.paths['/{index}/_ilm/remove']['post']"
description: "Add examples for remove policy from index operation"
update:
responses:
200:
content:
application/json:
examples:
removePolicyResponseExample1:
$ref: "../../specification/ilm/remove_policy/RemovePolicyResponseExample1.json"
8 changes: 8 additions & 0 deletions docs/overlays/elasticsearch-shared-example-overlays.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -107,3 +107,11 @@ actions:
examples:
esqlQueryRequestExample1:
$ref: "../../specification/esql/query/EsqlQueryApiRequestExample1.json"
- target: "$.components['requestBodies']['graph.explore']"
description: "Add example for graph explore request"
update:
content:
application/json:
examples:
graphExploreRequestExample1:
$ref: "../../specification/graph/explore/graphExploreRequestExample1.json"
Loading
Loading