-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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
[ResponseOps][Rules] OAS schema registration for newly versioned Rule APIs #189153
Conversation
Pinging @elastic/response-ops (Team:ResponseOps) |
💛 Build succeeded, but was flaky
Failed CI StepsMetrics [docs]
To update your PR or re-run it, just comment with: cc @adcoelho |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary
Issue: #187574
This PR updates
request
andresponse
schemas below for rule APIs to generate OAS documentation:POST /api/alerting/rule/{id?}/_enable
POST /api/alerting/rule/{id?}/_disable
POST /api/alerting/rule/{id?}/_update_api_key
How to test
server.oas.enabled: true
tokibana.dev.yml
yarn start --no-base-path
curl -s -u elastic:changeme http://localhost:5601/api/oas\?pathStartsWith\=/api/alerting/rule/ | jq
_enable
,_disable
and_update_api_key
in the resulting JSON