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

[Response Ops][Rules] OAS Ready Rule API #196150

Merged
merged 8 commits into from
Oct 15, 2024

Conversation

jcger
Copy link
Contributor

@jcger jcger commented Oct 14, 2024

Summary

Linked to #195182

muteAll

  • added 40x error codes to response
  • public access prop already set here
  • request schema already with description here
  • no response schema

unmuteAll

  • added 40x error codes to response
  • public access prop already set here
  • params schema already with description here
  • no response schema

rule types

  • added 40x error code to response
  • public access prop already set here
  • no request schema
  • added response schema descriptions

@jcger jcger added release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v9.0.0 backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) v8.16.0 labels Oct 14, 2024
@jcger jcger requested a review from a team as a code owner October 14, 2024 14:23
@elasticmachine
Copy link
Contributor

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

@jcger jcger changed the title [Response Ops][Rules] OAS Ready Mute All Rule API [Response Ops][Rules] OAS Ready Rule API Oct 14, 2024
kibanamachine and others added 3 commits October 14, 2024 15:07
…t --include-path /api/status --include-path /api/alerting/rule/ --include-path /api/alerting/rules --include-path /api/actions --include-path /api/security/role --include-path /api/spaces --include-path /api/fleet --update'
…t --include-path /api/status --include-path /api/alerting/rule/ --include-path /api/alerting/rules --include-path /api/actions --include-path /api/security/role --include-path /api/spaces --include-path /api/fleet --update'
@jcger jcger enabled auto-merge (squash) October 15, 2024 12:33
@jcger jcger merged commit 611082a into elastic:main Oct 15, 2024
42 of 43 checks passed
@kibanamachine
Copy link
Contributor

Starting backport for target branches: 8.x

https://github.com/elastic/kibana/actions/runs/11346427397

@elasticmachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

@jcger
Copy link
Contributor Author

jcger commented Oct 15, 2024

💚 All backports created successfully

Status Branch Result
8.x

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

Questions ?

Please refer to the Backport tool documentation

jcger added a commit to jcger/kibana that referenced this pull request Oct 15, 2024
## Summary

Linked to elastic#195182

### muteAll

- added 40x error codes to response
- `public` access prop already set
[here](https://github.com/elastic/kibana/blob/8545b9ccfbad97881406e56ffd96f452c94032b8/x-pack/plugins/alerting/server/routes/rule/apis/mute_all/mute_all_rule.ts#L28)
- request schema already with description
[here](https://github.com/elastic/kibana/blob/8545b9ccfbad97881406e56ffd96f452c94032b8/x-pack/plugins/alerting/common/routes/rule/apis/mute_all/schemas/v1.ts#L11)
- no response schema

### unmuteAll

- added 40x error codes to response
- `public` access prop already set
[here](https://github.com/elastic/kibana/blob/563910b672b6dbe4f9e7931e36ec41e674fe8eb3/x-pack/plugins/alerting/server/routes/rule/apis/unmute_all/unmute_all_rule.ts#L25)
- params schema already with description
[here](https://github.com/elastic/kibana/blob/563910b672b6dbe4f9e7931e36ec41e674fe8eb3/x-pack/plugins/alerting/common/routes/rule/apis/unmute_all/schemas/v1.ts#L11)
- no response schema

### rule types

- added 40x error code to response
- `public` access prop already set
[here](https://github.com/elastic/kibana/blob/563910b672b6dbe4f9e7931e36ec41e674fe8eb3/x-pack/plugins/alerting/server/routes/rule/apis/list_types/rule_types.ts#L23)
- no request schema
- added response schema descriptions

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
(cherry picked from commit 611082a)

# Conflicts:
#	x-pack/plugins/alerting/common/routes/rule/apis/list_types/schemas/v1.ts
#	x-pack/plugins/alerting/server/routes/rule/apis/list_types/rule_types.ts
jcger added a commit that referenced this pull request Oct 15, 2024
# Backport

This will backport the following commits from `main` to `8.x`:
- [[Response Ops][Rules] OAS Ready Rule API
(#196150)](#196150)

<!--- Backport version: 8.9.8 -->

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

<!--BACKPORT [{"author":{"name":"Julian
Gernun","email":"17549662+jcger@users.noreply.github.com"},"sourceCommit":{"committedDate":"2024-10-15T12:50:35Z","message":"[Response
Ops][Rules] OAS Ready Rule API (#196150)\n\n## Summary\r\n\r\nLinked to
https://github.com/elastic/kibana/issues/195182\r\n\r\n### muteAll
\r\n\r\n- added 40x error codes to response\r\n- `public` access prop
already
set\r\n[here](https://github.com/elastic/kibana/blob/8545b9ccfbad97881406e56ffd96f452c94032b8/x-pack/plugins/alerting/server/routes/rule/apis/mute_all/mute_all_rule.ts#L28)\r\n-
request schema already with
description\r\n[here](https://github.com/elastic/kibana/blob/8545b9ccfbad97881406e56ffd96f452c94032b8/x-pack/plugins/alerting/common/routes/rule/apis/mute_all/schemas/v1.ts#L11)\r\n-
no response schema\r\n\r\n### unmuteAll\r\n\r\n- added 40x error codes
to response\r\n- `public` access prop already
set\r\n[here](https://github.com/elastic/kibana/blob/563910b672b6dbe4f9e7931e36ec41e674fe8eb3/x-pack/plugins/alerting/server/routes/rule/apis/unmute_all/unmute_all_rule.ts#L25)\r\n-
params schema already with
description\r\n[here](https://github.com/elastic/kibana/blob/563910b672b6dbe4f9e7931e36ec41e674fe8eb3/x-pack/plugins/alerting/common/routes/rule/apis/unmute_all/schemas/v1.ts#L11)\r\n-
no response schema\r\n\r\n### rule types\r\n\r\n- added 40x error code
to response\r\n- `public` access prop already
set\r\n[here](https://github.com/elastic/kibana/blob/563910b672b6dbe4f9e7931e36ec41e674fe8eb3/x-pack/plugins/alerting/server/routes/rule/apis/list_types/rule_types.ts#L23)\r\n-
no request schema\r\n- added response schema
descriptions\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"611082ab3178efcc0cd6a9e073c409e4969aa618","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:ResponseOps","v9.0.0","backport:prev-minor","v8.16.0"],"number":196150,"url":"https://github.com/elastic/kibana/pull/196150","mergeCommit":{"message":"[Response
Ops][Rules] OAS Ready Rule API (#196150)\n\n## Summary\r\n\r\nLinked to
https://github.com/elastic/kibana/issues/195182\r\n\r\n### muteAll
\r\n\r\n- added 40x error codes to response\r\n- `public` access prop
already
set\r\n[here](https://github.com/elastic/kibana/blob/8545b9ccfbad97881406e56ffd96f452c94032b8/x-pack/plugins/alerting/server/routes/rule/apis/mute_all/mute_all_rule.ts#L28)\r\n-
request schema already with
description\r\n[here](https://github.com/elastic/kibana/blob/8545b9ccfbad97881406e56ffd96f452c94032b8/x-pack/plugins/alerting/common/routes/rule/apis/mute_all/schemas/v1.ts#L11)\r\n-
no response schema\r\n\r\n### unmuteAll\r\n\r\n- added 40x error codes
to response\r\n- `public` access prop already
set\r\n[here](https://github.com/elastic/kibana/blob/563910b672b6dbe4f9e7931e36ec41e674fe8eb3/x-pack/plugins/alerting/server/routes/rule/apis/unmute_all/unmute_all_rule.ts#L25)\r\n-
params schema already with
description\r\n[here](https://github.com/elastic/kibana/blob/563910b672b6dbe4f9e7931e36ec41e674fe8eb3/x-pack/plugins/alerting/common/routes/rule/apis/unmute_all/schemas/v1.ts#L11)\r\n-
no response schema\r\n\r\n### rule types\r\n\r\n- added 40x error code
to response\r\n- `public` access prop already
set\r\n[here](https://github.com/elastic/kibana/blob/563910b672b6dbe4f9e7931e36ec41e674fe8eb3/x-pack/plugins/alerting/server/routes/rule/apis/list_types/rule_types.ts#L23)\r\n-
no request schema\r\n- added response schema
descriptions\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"611082ab3178efcc0cd6a9e073c409e4969aa618"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","labelRegex":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/196150","number":196150,"mergeCommit":{"message":"[Response
Ops][Rules] OAS Ready Rule API (#196150)\n\n## Summary\r\n\r\nLinked to
https://github.com/elastic/kibana/issues/195182\r\n\r\n### muteAll
\r\n\r\n- added 40x error codes to response\r\n- `public` access prop
already
set\r\n[here](https://github.com/elastic/kibana/blob/8545b9ccfbad97881406e56ffd96f452c94032b8/x-pack/plugins/alerting/server/routes/rule/apis/mute_all/mute_all_rule.ts#L28)\r\n-
request schema already with
description\r\n[here](https://github.com/elastic/kibana/blob/8545b9ccfbad97881406e56ffd96f452c94032b8/x-pack/plugins/alerting/common/routes/rule/apis/mute_all/schemas/v1.ts#L11)\r\n-
no response schema\r\n\r\n### unmuteAll\r\n\r\n- added 40x error codes
to response\r\n- `public` access prop already
set\r\n[here](https://github.com/elastic/kibana/blob/563910b672b6dbe4f9e7931e36ec41e674fe8eb3/x-pack/plugins/alerting/server/routes/rule/apis/unmute_all/unmute_all_rule.ts#L25)\r\n-
params schema already with
description\r\n[here](https://github.com/elastic/kibana/blob/563910b672b6dbe4f9e7931e36ec41e674fe8eb3/x-pack/plugins/alerting/common/routes/rule/apis/unmute_all/schemas/v1.ts#L11)\r\n-
no response schema\r\n\r\n### rule types\r\n\r\n- added 40x error code
to response\r\n- `public` access prop already
set\r\n[here](https://github.com/elastic/kibana/blob/563910b672b6dbe4f9e7931e36ec41e674fe8eb3/x-pack/plugins/alerting/server/routes/rule/apis/list_types/rule_types.ts#L23)\r\n-
no request schema\r\n- added response schema
descriptions\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"611082ab3178efcc0cd6a9e073c409e4969aa618"}},{"branch":"8.x","label":"v8.16.0","labelRegex":"^v8.16.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v8.16.0 v9.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants