Skip to content

Commit

Permalink
pr review
Browse files Browse the repository at this point in the history
add doc link to new api
use reason.type remove instead oof deprecate for apis we will remove
  • Loading branch information
jcger committed Nov 26, 2024
1 parent c1d595f commit 76ada6e
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 4 deletions.
20 changes: 18 additions & 2 deletions docs/upgrade-notes.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -56,21 +56,36 @@ For Elastic Security solution release information, refer to {security-guide}/rel
====
*Details* +
`POST /api/alerts/alert/{id?}` has been replaced by `POST /api/alerting/rule/{id?}`
`GET /api/alerts/alert/{id}` has been replaced by `GET /api/alerting/rule/{id}`
`PUT /api/alerts/alert/{id}` has been replaced by `PUT /api/alerting/rule/rule/{id}`
`DELETE: /api/alerts/alert/{id}` has been replaced by `DELETE /api/alerting/rule/{id}`
`POST /api/alerts/alert/{id}/_disable` has been replaced by `POST /api/alerting/rule/{id}/_disable`
`POST /api/alerts/alert/{id}/_enable` has been replaced by `POST /api/alerting/rule/{id}/_enable`
`GET /api/alerts/_find` has been replaced by `GET /api/alerting/rules/_find`
`GET /api/alerts/_health` has been replaced by `GET /api/alerting/rule/_health`
`GET /api/alerts/list_alert_types` has been replaced by `GET /api/alerting/rule_types`
`POST /api/alerts/alert/{alert_id}/alert_instance/{alert_instance_id}/_mute` has been replaced by `POST /api/alerting/rule/{rule_id}/alert/{alert_id}/_mute`
`POST /api/alerts/alert/{alert_id}/alert_instance/{alert_instance_id}/_unmute` has been replaced by `POST /api/alerting/rule/{rule_id}/alert/{alert_id}/_unmute`
`POST /api/alerts/alert/{id}/_mute_all` has been replaced by `POST /api/alerting/rule/{id}/_mute_all`
`POST /api/alerts/alert/{id}/_unmute_all` has been replaced by `POST /api/alerting/rule/{id}/_unmute_all`
`POST /api/alerts/alert/{id}/_update_api_key` has been replaced by `POST /api/alerting/rule/{id}/_update_api_key`
`GET /api/alerts/{id}/_instance_summary` has been deprecated without replacement
`GET /api/alerts/{id}/state` has been deprecated without replacement
`GET /api/alerts/{id}/_instance_summary` has been deprecated without replacement. Will be removed in v9.0.0
`GET /api/alerts/{id}/state` has been deprecated without replacement. Will be removed in v9.0.0
*Impact* +
Deprecated endpoints will fail with a 404 status code starting from version 9.0.0
Expand All @@ -79,6 +94,7 @@ Deprecated endpoints will fail with a 404 status code starting from version 9.0.
Remove references to `GET /api/alerts/{id}/_instance_summary` endpoint.
Remove references to `GET /api/alerts/{id}/state` endpoint.
Replace references to endpoints listed as deprecated by it's replacement. See `Details` section.
The updated APIs can be found here https://www.elastic.co/docs/api/doc/kibana/v8/group/endpoint-alerting
====

[[breaking-199656]]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ export const getAlertInstanceSummaryRoute = (
documentationUrl: docLinks.links.alerting.legacyRuleApiDeprecations,
severity: 'warning',
reason: {
type: 'deprecate',
type: 'remove',
},
},
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ export const getAlertStateRoute = (
documentationUrl: docLinks.links.alerting.legacyRuleApiDeprecations,
severity: 'warning',
reason: {
type: 'deprecate',
type: 'remove',
},
},
},
Expand Down

0 comments on commit 76ada6e

Please sign in to comment.