[Rules] [Meta] Road to versioned HTTP APIs

[XavierM]

To not introduce any breaking changes or changes in the behavior of Rules and Connectors APIs when upgrading Kibana, we need to do changes in our endpoints. The needed steps to achieve this goal are described in the following section.

Steps

Disconnect API Interface with SO Attributes

The goal of this step is to isolate the SO attributes from the HTTP APIs. Any change in our SO attributes should not reflect a change in our API interfaces. To do that we need to

• [ ] Create types for domain objects
• [ ] Create TS interfaces/types for SOs and HTTP routes even if they are the same. Types for SOs should be in the server directory
• [ ] Explicitly map the SO attributes to the response and vice-versa even if they are the same. No more spreading

APIs:

Rules:

• [x] POST /api/alerts/alert/{id?} -> LEGACY -> We won't do anything
• [x] POST /api/alerts/_find -> LEGACY -> We won't do anything
• [x] GET /api/alerts/alert/{id} -> LEGACY-> We won't do anything
• [x] PUT /api/alerts/alert/{id} -> LEGACY -> We won't do anything
• [x] PATCH /internal/alerting/rules/_bulk_delete -> @guskovaue https://github.com/elastic/kibana/pull/164015
• [x] PATCH /internal/alerting/rules/_bulk_disable -> @guskovaue https://github.com/elastic/kibana/pull/167503
• [x] POST /internal/alerting/rules/_bulk_edit -> @JiaweiWu
• [x] PATCH /internal/alerting/rules/_bulk_enable -> @JiaweiWu https://github.com/elastic/kibana/pull/179778
• [x] POST /internal/alerting/rule/{id}/_clone/{newId?} -> @JiaweiWu https://github.com/elastic/kibana/pull/180549
• [x] POST /api/alerting/rule/{id?} -> @JiaweiWu https://github.com/elastic/kibana/pull/179587
• [x] GET /internal/alerting/rules/_find -> @JiaweiWu https://github.com/elastic/kibana/issues/180551
• [x] GET /api/alerting/rules/_find -> @JiaweiWu https://github.com/elastic/kibana/issues/180551
• [x] GET /internal/alerting/rule/{id}-> @JiaweiWu https://github.com/elastic/kibana/pull/181304
• [x] GET /api/alerting/rule/{id} -> @JiaweiWu https://github.com/elastic/kibana/pull/181304
• [x] GET /internal/alerting/rule/{id}/_resolve-> @Zacqary for https://github.com/elastic/kibana/pull/168886
• [x] PUT /api/alerting/rule/{id} -> @JiaweiWu https://github.com/elastic/kibana/pull/179587
• [x] POST /internal/alerting/rule/{id}/_snooze -> @Zacqary for https://github.com/elastic/kibana/pull/168886
• [x] POST /internal/alerting/rule/{id}/_unsnooze -> @Zacqary for https://github.com/elastic/kibana/pull/168886
• [x] POST /internal/alerting/rules/_aggregate -> @jcger https://github.com/elastic/kibana/pull/164284
• [x] GET /internal/alerting/rules/_aggregate -> DELETE ENDPOINT -> @jcger https://github.com/elastic/kibana/pull/164284
• [x] DELETE /api/alerting/rule/{id} -> @JiaweiWu https://github.com/elastic/kibana/pull/181521
• [x] POST /api/alerting/rule/{id}/_disable -> @adcoelho https://github.com/elastic/kibana/pull/188659
• [x] POST /api/alerting/rule/{id}/_enable -> @adcoelho https://github.com/elastic/kibana/pull/188645
• [ ] GET /internal/alerting/rule/{id}/_action_error_log -> @XavierM
• [ ] GET /internal/alerting/_global_execution_kpi -> @Zacqary
• [ ] GET /internal/alerting/_global_execution_logs -> @Zacqary
• [ ] GET /internal/alerting/rule/{id}/_alert_summary -> @Zacqary
• [ ] GET /internal/alerting/rule/{id}/_execution_kpi -> @Zacqary
• [ ] GET /internal/alerting/rule/{id}/_execution_log POST /internal/alerting -> @Zacqary
• [ ] GET /internal/alerting/rule/{id}/state -> @guskovaue
• [x] GET /internal/alerting/rules/_tags -> @jcger https://github.com/elastic/kibana/pull/165849
• [ ] GET /api/alerting/_health -> @guskovaue
• [x] POST /api/alerting/rule/{rule_id}/alert/{alert_id}/_mute -> @jcger https://github.com/elastic/kibana/pull/165573
• [ ] POST /api/alerting/rule/{id}/_mute_all -> @jcger
• [ ] GET /api/alerting/rule/{id}/_resolve -> @jcger
• [ ] GET /api/alerting/rule_types -> @jcger
• [ ] POST /api/alerting/rule/{id}/_run_soon -> @guskovaue
• [x] POST /api/alerting/rule/{rule_id}/alert/{alert_id}/_unmute -> @umbopepato https://github.com/elastic/kibana/pull/188830
• [ ] POST /api/alerting/rule/{id}/_unmute_all -> @guskovaue
• [x] POST /api/alerting/rule/{id}/_update_api_key -> @adcoelho https://github.com/elastic/kibana/pull/188722

Rule Settings:

• [ ] GET /internal/alerting/rules/settings/_flapping -> @Zacqary
• [ ] POST /internal/alerting/rules/settings/_flapping -> @Zacqary

Maintenance Windows:

• [x] GET /internal/alerting/rules/maintenance_window/_active (active) -> @JiaweiWu https://github.com/elastic/kibana/pull/162446
• [x] POST /internal/alerting/rules/maintenance_window/_bulk_get (bulk get) -> @JiaweiWu https://github.com/elastic/kibana/pull/162446
• [x] GET /internal/alerting/rules/maintenance_window/_find (find) -> @JiaweiWu https://github.com/elastic/kibana/pull/162446
• [x] POST /internal/alerting/rules/maintenance_window/{id}/_finish (finish) -> @JiaweiWu https://github.com/elastic/kibana/pull/162446
• [x] POST /internal/alerting/rules/maintenance_window/{id}/_archive (archive, maybe this should be archive/unarchive, 2 routes) -> @JiaweiWu https://github.com/elastic/kibana/pull/162446
• [x] POST /internal/alerting/rules/maintenance_window (create) -> @JiaweiWu https://github.com/elastic/kibana/pull/162446
• [x] DELETE /internal/alerting/rules/maintenance_window/{id} (delete) -> @JiaweiWu https://github.com/elastic/kibana/pull/162446
• [x] GET /internal/alerting/rules/maintenance_window/{id} (get) -> @JiaweiWu https://github.com/elastic/kibana/pull/162446
• [x] POST /internal/alerting/rules/maintenance_window/{id} (update) -> @JiaweiWu https://github.com/elastic/kibana/pull/162446

[elasticmachine]

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

[JiaweiWu]

PoC PR: https://github.com/elastic/kibana/pull/158786