[ResponseOps][Rules][Meta] Add OAS support for Rules APIs

[cnasikas]

The Core team added support for OAS in the Kibana routes. To provide users with an up-to-date OAS for the documented public Rules API we need to a) version the remaining HTTP routes b) move the parameters schema of all rule types in a package and c) register the OAS schema on each route. Below, for each category, all steps to achieve our goal are listed.

Related: #157883, #187572, #187574
Example PR that registers OAS schema: #181277

Version HTTP routes

Beta Give feedback

1. POST /api/alerting/rule/{id}/_disable [ResponseOps][Rules] Version _enable, _disable, _update_api_key, and _unmute APIs #187572
2. POST /api/alerting/rule/{id}/_enable [ResponseOps][Rules] Version _enable, _disable, _update_api_key, and _unmute APIs #187572
3. GET /api/alerting/rule_types [ResponseOps][Rules] Version the rest of rule's public APIs #195181
4. POST /api/alerting/rule/{id}/_mute_all [ResponseOps][Rules] Version the rest of rule's public APIs #195181
5. POST /api/alerting/rule/{id}/_unmute_all [ResponseOps][Rules] Version the rest of rule's public APIs #195181
6. POST /api/alerting/rule/{id}/_update_api_key [ResponseOps][Rules] Version _enable, _disable, _update_api_key, and _unmute APIs #187572
7. POST /api/alerting/rule/{rule_id}/alert/{alert_id}/_unmute [ResponseOps][Rules] Version _enable, _disable, _update_api_key, and _unmute APIs #187572
8. GET /api/alerting/_health [ResponseOps][Rules] Version the rest of rule's public APIs #195181

OAS schema registration

Beta Give feedback

1. POST /api/alerting/rule/{id?} [ResponseOps][Rules] OAS schema registration for Rule APIs #187574
2. GET /api/alerting/rule/{id} [ResponseOps][Rules] OAS schema registration for Rule APIs #187574
3. DELETE /api/alerting/rule/{id} [ResponseOps][Rules] OAS schema registration for Rule APIs #187574
4. PUT /api/alerting/rule/{id} [ResponseOps][Rules] OAS schema registration for Rule APIs #187574
5. GET /api/alerting/rules/_find [ResponseOps][Rules] OAS schema registration for Rule APIs #187574
6. POST /api/alerting/rule/{id}/_disable [ResponseOps][Rules] OAS schema registration for Rule APIs #187574
7. POST /api/alerting/rule/{id}/_enable [ResponseOps][Rules] OAS schema registration for Rule APIs #187574
8. GET /api/alerting/rule_types [ResponseOps][Rules] OAS schema registration of the rest of rule's public APIs #195182
9. POST /api/alerting/rule/{id}/_mute_all [ResponseOps][Rules] OAS schema registration of the rest of rule's public APIs #195182
10. POST /api/alerting/rule/{id}/_unmute_all [ResponseOps][Rules] OAS schema registration of the rest of rule's public APIs #195182
11. POST /api/alerting/rule/{id}/_update_api_key [ResponseOps][Rules] OAS schema registration for Rule APIs #187574
12. POST /api/alerting/rule/{rule_id}/alert/{alert_id}/_mute [ResponseOps][Rules] OAS schema registration for Rule APIs #187574
13. POST /api/alerting/rule/{rule_id}/alert/{alert_id}/_unmute [ResponseOps][Rules] OAS schema registration for Rule APIs #187574
14. GET /api/alerting/_health [ResponseOps][Rules] OAS schema registration of the rest of rule's public APIs #195182

Rule params.

Beta Give feedback

1. Create a package where are rule params will exist. The alerting plugin treats it as a blackbox.
2. Enforce new rule types to define a schema in the new package.
3. Move anomaly detection rule type params to the new package.
4. Move anomaly detection jobs health params to the new package.
5. Move APM anomaly rule type params to the new package.
6. Move CCR read exceptions rule type params to the new package.
7. Move cluster health rule type params to the new package.
8. Move CPU usage rule type params to the new package.
9. Move custom threshold rule type params to the new package.
10. Move disk usage rule type params to the new package.
11. Move ES query rule type params to the new package.
12. Move ES version mismatch type params to the new package.
13. Move error count threshold rule type params to the new package.
14. Move failed transaction rate threshold rule type params to the new package.
15. Move index threshold rule type params to the new package.
16. Move inventory rule type params to the new package.
17. Move Kibana version mismatch rule type params to the new package.
18. Move latency threshold rule type params to the new package.
19. Move license expiration threshold rule type params to the new package.
20. Move log threshold rule type params to the new package.
21. Move logstash version mismatch rule type params to the new package.
22. Move memory usage (JVM) rule type params to the new package.
23. Move metric threshold rule type params to the new package.
24. Move missing monitoring data rule type params to the new package.
25. Move nodes changed rule type params to the new package.
26. Move shard size rule type params to the new package.
27. Move SLO burn rate rule type params to the new package.
28. Move synthetics monitoring status rule type params to the new package.
29. Move synthetics TSL certificate rule type params to the new package.
30. Move thread pool search rejections rule type params to the new package.
31. Move thread pool write rejections rule type params to the new package.
32. Move tracking containment rule type params to the new package.
33. Move transform health rule type params to the new package.
34. Move uptime duration anomaly rule type params to the new package.
35. Move uptime monitor status rule type params to the new package.
36. Move uptime TSL rule type params to the new package.

[elasticmachine]

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

[adcoelho]

I added the GET /api/alerting/_health endpoint to the tasks.

[jcger]

I miss the tasks to update params param to use the definition created in the new package

[cnasikas]

Good point @jcger! I will update the issue accordingly.