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

[DOCS] Create OAS for get rule types and get alerting framework health #148774

Merged
merged 7 commits into from Jan 17, 2023

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Jan 12, 2023

Summary

Relates to #137240

This PR creates the open API specification for https://www.elastic.co/guide/en/kibana/master/list-rule-types-api.html and https://www.elastic.co/guide/en/kibana/master/get-alerting-framework-health-api.html

It also adds some missing 4xx response codes for other endpoints.

@github-actions
Copy link

Documentation preview:

@lcawl lcawl added Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) docs backport:prev-minor Backport to the previous minor version (i.e. one version back from main) v8.7.0 labels Jan 12, 2023
@lcawl lcawl marked this pull request as ready for review January 12, 2023 17:00
@lcawl lcawl requested review from a team as code owners January 12, 2023 17:00
@elasticmachine
Copy link
Contributor

Pinging @elastic/response-ops (Team:ResponseOps)

@lcawl lcawl changed the title [DOCS] Create open API specification for get rule types [DOCS] Create OAS for get rule types and get alerting framework health Jan 13, 2023
@lcawl lcawl enabled auto-merge (squash) January 17, 2023 01:39
Copy link
Contributor

@szabosteve szabosteve left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.6

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

lcawl added a commit that referenced this pull request Jan 17, 2023
… health (#148774) (#149064)

# Backport

This will backport the following commits from `main` to `8.6`:
- [[DOCS] Create OAS for get rule types and get alerting framework
health (#148774)](#148774)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2023-01-17T17:53:48Z","message":"[DOCS]
Create OAS for get rule types and get alerting framework health
(#148774)","sha":"fa68cb432b306ca54a68eceb5ca86f0dff326281","branchLabelMapping":{"^v8.7.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:enhancement","Feature:Alerting","Team:ResponseOps","docs","backport:prev-minor","v8.7.0"],"number":148774,"url":"#148774
Create OAS for get rule types and get alerting framework health
(#148774)","sha":"fa68cb432b306ca54a68eceb5ca86f0dff326281"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v8.7.0","labelRegex":"^v8.7.0$","isSourceBranch":true,"state":"MERGED","url":"#148774
Create OAS for get rule types and get alerting framework health
(#148774)","sha":"fa68cb432b306ca54a68eceb5ca86f0dff326281"}}]}]
BACKPORT-->

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:prev-minor Backport to the previous minor version (i.e. one version back from main) docs Feature:Alerting release_note:enhancement Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v8.6.1 v8.7.0
Development

Successfully merging this pull request may close these issues.

None yet

5 participants