Skip to content

Commit 964b71f

Browse files
committed
feat(alerting): Add specs for alerting namespace
Add OpenAPI specs for the Alerting plugin's REST API, covering: - Monitor create, get, update, delete, search, and execute - Alert get and acknowledge - Finding search - Destination get (deprecated, kept for backwards compatibility) - Email account and email group get, exists, and search - Scheduled-job stats Update the pre-existing opendistro-to-plugins superseded operation entries for alerting to use the same path parameter names as the new namespace file, since the merger substitutes parameter names from `superseded_by` when generating the legacy `_opendistro` aliases. Closes #221
1 parent 5691b4a commit 964b71f

3 files changed

Lines changed: 1983 additions & 9 deletions

File tree

spec/_superseded_operations.yaml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ $schema: ./json_schemas/_superseded_operations.schema.yaml
1212
- GET
1313
- POST
1414
/_opendistro/_alerting/destinations/email_accounts/{emailAccountID}:
15-
superseded_by: /_plugins/_alerting/destinations/email_accounts/{emailAccountID}
15+
superseded_by: /_plugins/_alerting/destinations/email_accounts/{email_account_id}
1616
operations:
1717
- GET
1818
- HEAD
@@ -22,12 +22,12 @@ $schema: ./json_schemas/_superseded_operations.schema.yaml
2222
- GET
2323
- POST
2424
/_opendistro/_alerting/destinations/email_groups/{emailGroupID}:
25-
superseded_by: /_plugins/_alerting/destinations/email_groups/{emailGroupID}
25+
superseded_by: /_plugins/_alerting/destinations/email_groups/{email_group_id}
2626
operations:
2727
- GET
2828
- HEAD
2929
/_opendistro/_alerting/destinations/{destinationID}:
30-
superseded_by: /_plugins/_alerting/destinations/{destinationID}
30+
superseded_by: /_plugins/_alerting/destinations/{destination_id}
3131
operations:
3232
- GET
3333
/_opendistro/_alerting/monitors:
@@ -48,34 +48,34 @@ $schema: ./json_schemas/_superseded_operations.schema.yaml
4848
operations:
4949
- GET
5050
/_opendistro/_alerting/monitors/{monitorID}:
51-
superseded_by: /_plugins/_alerting/monitors/{monitorID}
51+
superseded_by: /_plugins/_alerting/monitors/{monitor_id}
5252
operations:
5353
- GET
5454
- HEAD
5555
- PUT
5656
- DELETE
5757
/_opendistro/_alerting/monitors/{monitorID}/_acknowledge/alerts:
58-
superseded_by: /_plugins/_alerting/monitors/{monitorID}/_acknowledge/alerts
58+
superseded_by: /_plugins/_alerting/monitors/{monitor_id}/_acknowledge/alerts
5959
operations:
6060
- POST
6161
/_opendistro/_alerting/monitors/{monitorID}/_execute:
62-
superseded_by: /_plugins/_alerting/monitors/{monitorID}/_execute
62+
superseded_by: /_plugins/_alerting/monitors/{monitor_id}/_execute
6363
operations:
6464
- POST
6565
/_opendistro/_alerting/stats/:
6666
superseded_by: /_plugins/_alerting/stats/
6767
operations:
6868
- GET
6969
/_opendistro/_alerting/stats/{metric}:
70-
superseded_by: /_plugins/_alerting/stats/{metric}
70+
superseded_by: /_plugins/_alerting/stats/{stat}
7171
operations:
7272
- GET
7373
/_opendistro/_alerting/{nodeId}/stats/:
74-
superseded_by: /_plugins/_alerting/{nodeId}/stats/
74+
superseded_by: /_plugins/_alerting/{node_id}/stats/
7575
operations:
7676
- GET
7777
/_opendistro/_alerting/{nodeId}/stats/{metric}:
78-
superseded_by: /_plugins/_alerting/{nodeId}/stats/{metric}
78+
superseded_by: /_plugins/_alerting/{node_id}/stats/{stat}
7979
operations:
8080
- GET
8181
/_opendistro/_anomaly_detection/detectors:

0 commit comments

Comments
 (0)