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

[ResponseOps][Rules] Removal of deprecated Rules APIs #195179

Open
cnasikas opened this issue Oct 7, 2024 · 8 comments · May be fixed by #203148
Open

[ResponseOps][Rules] Removal of deprecated Rules APIs #195179

cnasikas opened this issue Oct 7, 2024 · 8 comments · May be fixed by #203148
Assignees
Labels
Feature:Alerting/RulesFramework Issues related to the Alerting Rules Framework Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams)

Comments

@cnasikas
Copy link
Member

cnasikas commented Oct 7, 2024

In 7.13 we deprecate the following APIs:

Create rule: POST /api/alerts/alert/
Get rule: GET /api/alerts/alert/
Update rule: PUT /api/alerts/alert/
Delete rule: DELETE: /api/alerts/alert/
Disable rule: POST /api/alerts/alert//_disable
Enable rule: POST /api/alerts/alert//_enable
Find rules: GET /api/alerts/_find
Get Alerting framework health: GET /api/alerts/_health
Get alert instance summary: GET /api/alerts//_instance_summary
Get alert state: GET /api/alerts//state
List rule types: GET /api/alerts/list_alert_types
Mute alert: POST /api/alerts/alert/<alert_id>/alert_instance/<alert_instance_id>/_mute
Unmute alert: POST /api/alerts/alert/<alert_id>/alert_instance/<alert_instance_id>/_unmute
Mute all alerts: POST /api/alerts/alert//_mute_all
Unmute all alerts: POST /api/alerts/alert//_unmute_all
Update API key: POST /api/alerts/alert//_update_api_key

In 9.0 we should remove the deprecated APIs. Alternatives can be found here.

@cnasikas cnasikas added Feature:Alerting/RulesFramework Issues related to the Alerting Rules Framework Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) labels Oct 7, 2024
@elasticmachine
Copy link
Contributor

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

@cnasikas cnasikas changed the title [Rules] Removal of deprecated APIs [ResponseOps][Rules] Removal of deprecated APIs Oct 7, 2024
@cnasikas cnasikas changed the title [ResponseOps][Rules] Removal of deprecated APIs [ResponseOps][Rules] Removal of deprecated Rules APIs Oct 11, 2024
@jcger
Copy link
Contributor

jcger commented Oct 16, 2024

I've seen also this issue mentioning adding a deprecated object #196095. Should we add deprecated info or delete them?

@cnasikas
Copy link
Member Author

cnasikas commented Oct 16, 2024

Good point @jcger! We should add the deprecated object in 8.17/8.18 so users are being informed.

@cnasikas
Copy link
Member Author

Could you please create an issue about it and add it as a sub-issue here? Same for the Cases APIs here #194266.

@jcger
Copy link
Contributor

jcger commented Oct 16, 2024

Done, here are the links:
for rules: #196556
for cases: #196557

@jcger
Copy link
Contributor

jcger commented Nov 25, 2024

@cnasikas
Copy link
Member Author

Correct, my mistake. I corrected it.

@lcawl
Copy link
Contributor

lcawl commented Dec 12, 2024

The API documentation is affected by this issue and I believe those endpoints are all manually-maintained in https://github.com/elastic/kibana/blob/main/x-pack/plugins/alerting/docs/openapi/entrypoint.yaml

... so it'll just be a matter of removing the appropriate endpoints from that file (or removing individual operations from the files it points to) then re-generating the bundle per the readme. If there are none left in the bundle (hooray) we can delete that whole folder and remove it from https://github.com/elastic/kibana/blob/main/oas_docs/scripts/merge_ess_oas.js

@js-jankisalvi js-jankisalvi linked a pull request Dec 12, 2024 that will close this issue
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:Alerting/RulesFramework Issues related to the Alerting Rules Framework Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants