Skip to content

[8.x] [DOCS] Add overlays for CCR API examples (#3672) #3685

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
Jan 31, 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
68 changes: 68 additions & 0 deletions docs/overlays/elasticsearch-openapi-overlays.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,74 @@ actions:
examples:
resumeFollowIndexResponseExample1:
$ref: "../../specification/ccr/resume_follow/examples/response/ResumeFollowIndexResponseExample1.yaml"
- target: "$.paths['/{index}/_ccr/unfollow']['post']"
description: "Add examples for unfollow an index"
update:
responses:
200:
content:
application/json:
examples:
ccrUnfollowIndexResponseExample1:
$ref: "../../specification/ccr/unfollow/examples/response/UnfollowIndexResponseExample1.yaml"
- target: "$.paths['/_ccr/stats']['get']"
description: "Add examples for get ccr stats"
update:
responses:
200:
content:
application/json:
examples:
ccrStatsResponseExample1:
$ref: "../../specification/ccr/stats/examples/response/CcrStatsResponseExample1.yaml"
- target: "$.paths['/_ccr/auto_follow/{name}/resume']['post']"
description: "Add examples for resume auto-follow pattern"
update:
responses:
200:
content:
application/json:
examples:
ccrResumeAutoFollowResponseExample1:
$ref: "../../specification/ccr/resume_auto_follow_pattern/examples/response/ResumeAutoFollowPatternResponseExample1.yaml"
- target: "$.paths['/{index}/_ccr/pause_follow']['post']"
description: "Add examples for resume auto-follow pattern"
update:
responses:
200:
content:
application/json:
examples:
ccrPauseFollowResponseExample1:
$ref: "../../specification/ccr/pause_follow/examples/response/PauseFollowIndexResponseExample1.yaml"
- target: "$.paths['/_ccr/auto_follow/{name}/pause']['post']"
description: "Add examples for pause auto-follow pattern"
update:
responses:
200:
content:
application/json:
examples:
ccrPauseAutoFollowPatternResponseExample1:
$ref: "../../specification/ccr/pause_auto_follow_pattern/examples/response/PauseAutoFollowPatternResponseExample1.yaml"
- target: "$.components['responses']['ccr.get_auto_follow_pattern#200']"
description: "Add examples for get auto-follow pattern"
update:
content:
application/json:
examples:
ccrPauseAutoFollowPatternResponseExample1:
$ref: "../../specification/ccr/get_auto_follow_pattern/examples/response/GetAutoFollowPatternResponseExample1.yaml"
- target: "$.paths['/{index}/_ccr/stats']['get']"
description: "Add examples for get follower stats"
update:
responses:
200:
content:
application/json:
examples:
ccrFollowerStatsResponseExample1:
$ref: "../../specification/ccr/follow_stats/examples/response/FollowIndexStatsResponseExample1.yaml"
## Examples for cluster
- target: "$.components['requestBodies']['cluster.allocation_explain']"
description: "Add examples for cluster allocation explain operation"
Expand Down
54 changes: 39 additions & 15 deletions output/openapi/elasticsearch-openapi.json

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

Loading