Skip to content
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

[Backport 8.x] [DOCS] Convert final examples from JSON to YAML #3693

Merged
merged 1 commit into from
Feb 4, 2025
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
22 changes: 22 additions & 0 deletions docs/overlays/elasticsearch-openapi-overlays.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -267,6 +267,28 @@ actions:
examples:
ccrFollowerStatsResponseExample1:
$ref: "../../specification/ccr/follow_stats/examples/response/FollowIndexStatsResponseExample1.yaml"
- target: "$.paths['/{index}/_ccr/info']['get']"
description: "Add examples for get follower info"
update:
responses:
200:
content:
application/json:
examples:
ccrFollowerInfoResponseExample1:
$ref: "../../specification/ccr/follow_info/examples/response/FollowInfoResponseExample1.yaml"
ccrFollowerInfoResponseExample2:
$ref: "../../specification/ccr/follow_info/examples/response/FollowInfoResponseExample2.yaml"
- target: "$.paths['/_ccr/auto_follow/{name}']['delete']"
description: "Add examples for delete auto follow pattern"
update:
responses:
200:
content:
application/json:
examples:
ccrAutoFollowPatternDeleteResponseExample1:
$ref: "../../specification/ccr/delete_auto_follow_pattern/examples/response/DeleteAutoFollowPatternResponseExample1.yaml"
## Examples for cluster
- target: "$.components['requestBodies']['cluster.allocation_explain']"
description: "Add examples for cluster allocation explain operation"
Expand Down
24 changes: 24 additions & 0 deletions docs/overlays/elasticsearch-shared-overlays.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2463,6 +2463,30 @@ actions:
examples:
asyncSearchSubmitResponseExample1:
$ref: "../../specification/async_search/submit/examples/response/AsyncSearchSubmitResponseExample1.yaml"
- target: "$.paths['/_async_search/status/{id}']['get']"
description: "Add examples for get async search status"
update:
responses:
200:
content:
application/json:
examples:
asyncSearchStatusResponseExample1:
$ref: "../../specification/async_search/status/examples/response/AsyncSearchStatusResponseExample1.yaml"
asyncSearchStatusResponseExample2:
$ref: "../../specification/async_search/status/examples/response/AsyncSearchStatusResponseExample2.yaml"
asyncSearchStatusResponseExample3:
$ref: "../../specification/async_search/status/examples/response/AsyncSearchStatusResponseExample3.yaml"
- target: "$.paths['/_async_search/{id}']['get']"
description: "Add examples for get async search"
update:
responses:
200:
content:
application/json:
examples:
asyncSearchResponseExample1:
$ref: "../../specification/async_search/get/examples/response/AsyncSearchGetResponseExample1.yaml"
## Examples for search applications
- target: "$.paths['/_application/search_application']['get']"
description: "Add examples for get search applications operation"
Expand Down
20 changes: 10 additions & 10 deletions output/openapi/elasticsearch-openapi.json

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

12 changes: 6 additions & 6 deletions output/openapi/elasticsearch-serverless-openapi.json

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

Loading