Skip to content

Commit 8668bde

Browse files
STAC-25181: Communicate user suppressions as part of the MonitorCheckStatus response
1 parent 5236ebb commit 8668bde

3 files changed

Lines changed: 12 additions & 5 deletions

File tree

‎spec/monitors_check_status.api.yaml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,12 @@ components:
151151
$ref: "#/components/schemas/MonitorCheckStatusComponent"
152152
monitorId:
153153
$ref: "common.api.yaml#/components/schemas/MonitorReferenceId"
154+
checkStateId:
155+
type: string
156+
description: "The check state id within the monitor's output."
157+
subStream:
158+
type: string
159+
description: "The sub-stream identifier (present for ExternalMonitors only)."
154160
monitorName:
155161
type: string
156162
monitorDescription:
@@ -172,6 +178,7 @@ components:
172178
- triggeredTimestamp
173179
- metrics
174180
- monitorId
181+
- checkStateId
175182
- monitorName
176183
- topologyTime
177184
- component

‎spec/openapi.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ paths:
5555
/monitor/checkStatus/{identifier}/relatedFailures: { $ref: "monitors_check_status.api.yaml#/paths/%2Fmonitor%2FcheckStatus%2F%7Bidentifier%7D%2FrelatedFailures" }
5656
/monitor/checkStatus/{identifier}/healthHistory: { $ref: "monitors_check_status.api.yaml#/paths/%2Fmonitor%2FcheckStatus%2F%7Bidentifier%7D%2FhealthHistory" }
5757
/suppressions: { $ref: "suppressions.api.yaml#/paths/%2Fsuppressions" }
58-
/suppressions/{suppressionIdentifier}: { $ref: "suppressions.api.yaml#/paths/%2Fsuppressions%2F%7BsuppressionIdentifier%7D" }
58+
/suppressions/{identifier}: { $ref: "suppressions.api.yaml#/paths/%2Fsuppressions%2F%7Bidentifier%7D" }
5959
/notifications/channels/slack/oauth-redirect: { $ref: "notification_channels.api.yaml#/paths/%2Fnotifications%2Fchannels%2Fslack%2Foauth-redirect" }
6060
/notifications/channels/slack/oauth-callback: { $ref: "notification_channels.api.yaml#/paths/%2Fnotifications%2Fchannels%2Fslack%2Foauth-callback" }
6161
/notifications/channels/slack/{channelId}: { $ref: "notification_channels.api.yaml#/paths/%2Fnotifications%2Fchannels%2Fslack%2F%7BchannelId%7D" }

‎spec/suppressions.api.yaml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,15 @@ paths:
3434
"500":
3535
$ref: "#/components/responses/suppressionApiError"
3636

37-
/suppressions/{suppressionIdentifier}:
37+
/suppressions/{identifier}:
3838
delete:
3939
tags:
4040
- suppression
4141
summary: "Delete a user suppression"
4242
description: "Remove a user suppression by its identifier."
4343
operationId: deleteUserSuppression
4444
parameters:
45-
- $ref: "#/components/parameters/suppressionIdentifier"
45+
- $ref: "#/components/parameters/identifier"
4646
responses:
4747
"204":
4848
description: "Suppression removed"
@@ -55,9 +55,9 @@ paths:
5555

5656
components:
5757
parameters:
58-
suppressionIdentifier:
58+
identifier:
5959
in: path
60-
name: suppressionIdentifier
60+
name: identifier
6161
required: true
6262
schema:
6363
type: string

0 commit comments

Comments
 (0)