-
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
Create new rule HTTP APIs that use the new terminology #90377
Comments
Pinging @elastic/kibana-alerting-services (Team:Alerting Services) |
re: #93943 I'm curious about the changes of And how will we test the legacy paths? I guess we'll have to duplicate the existing FTs - maybe rename the existing ones "legacy"? |
The latter, we have a separate issue to move our code to use the new APIs -> #90381. The reason for the split is to break down the work and to have the new APIs as soon as we can so we can ask the teams to convert their code ASAP.
I plan to follow how @gmmorris did it for the connectors in PR: #92451. |
Based on the
Below are some changes I would like to propose:
|
This is the first step of #90375, which summarizes the new terminology to use in Kibana alerting. This issue covers the rules portion, where we use alert as the current terminology at this time. This new terminology change includes URL, parameters, body, and response in the new APIs. Don't forget docs.
Alerts Plugin Api Paths
Important note: When introducing these new APIs we need to rename all fields in bodies need to be renamed from Camel Case to Snake Case as per our Style Guide. In the code they need to be renamed back to Camel Case.
This change will require changing the
Alerts
plugin back to it's original name ofAlerting
, as it becomes confusing with Alerts being renames Rules./api/alerts/alert
=>/api/alerting/rule
/api/alerts/_find
=>/api/alerting/rules/_find
/api/alerts/alert/{id}
=>/api/alerting/rule/{id}
/api/alerts/alert/{id}/state
=>/api/alerting/rule/{id}/state
/api/alerts/alert/{id}/_instance_summary
=>/api/alerting/rule/{id}/_alert_summary
/api/alerts/list_alert_types
=>/api/alerting/list_rule_types
/api/alerts/alert/{id}
=> E/api/alerting/rule/{id}
/api/alerts/alert/{id}
=>/api/alerting/rule/{id}
/api/alerts/alert/{id}/_enable
=>/api/alerting/rule/{id}/_enable
/api/alerts/alert/{id}/_disable
=>/api/alerting/rule/{id}/_disable
/api/alerts/alert/{id}/_mute_all
=>/api/alerting/rule/{id}/_mute_all
/api/alerts/alert/{alert_id}/alert_instance/{alert_instance_id}/_mute
=>/api/alerting/rule/{rule_id}/alert/{alert_id}/_mute
/api/alerts/alert/{id}/_unmute_all
=>/api/alerting/rule/{rule_id}/_unmute_all
/api/alerts/alert/{alertId}/alert_instance/{alert_instance_id}/_unmute
=>/api/alerting/rule/{rule_id}/alert/{alert_id}/_unmute
/api/alerts/alert/{id}/_update_api_key
=>/api/alerting/rule/{id}/_update_api_key
For details on the Api migration see the notes under #90375 (comment)
The text was updated successfully, but these errors were encountered: