COBS-1288: Add Insights alert instances OpenAPI - #1226
Open
adityasingh-beep wants to merge 2 commits into
Open
adityasingh-beep wants to merge 2 commits into
adityasingh-beep wants to merge 2 commits into
Conversation
adityasingh-beep
marked this pull request as ready for review
September 16, 2026 13:30
Adds the read-only Insights alert instances endpoints:
- GET /v2/insights/alert-instances (list; filters: status, rule_id,
resource_urn; standard page/per_page pagination with links/meta envelope)
- GET /v2/insights/alert-instances/{id}
Spec follows the agreed Alerts Public Insights API contract: snake_case
fields, lowercase enums (severity: warning|critical, status:
active|resolved), RFC 3339 timestamps, uuid identifiers, and the standard
DO list envelope via shared pages/meta components. Scope: insights:read,
matching the staging Edge routing for COBS-1287.
Co-authored-by: Cursor <cursoragent@cursor.com>
- Add Insights to x-tagGroups so the section renders in Redoc. - Document that alert instances are ordered by triggered_at DESC and note the offset-pagination stability caveat on an append-only list. - Mark alert_instance.resource_urn as optional and describe when it may be empty (non-resource-bound signals, e.g. cluster/pod/namespace- scoped Kubernetes alerts; see optionalResourceURN in executioner/pkg/alertrule/store.go). Co-authored-by: Cursor <cursoragent@cursor.com>
adityasingh-beep
force-pushed
the
adityasingh/COBS-1288-Publish-OpenAPI-spec-for-Insights-alert-instances
branch
from
September 30, 2026 08:26
23cb9a3 to
251580c
Compare
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
/v2/insights/alert-instances(COBS-1288):GET /v2/insights/alert-instances— list, withstatus(active/resolved),rule_id, andresource_urnfiltersGET /v2/insights/alert-instances/{id}— retrieve a single alert instanceseverity: warning|critical,status: active|resolved), RFC 3339 timestamps, uuid ids,links/metalist envelope,page/per_page(default 20, max 200), scopeinsights:read.Test plan
alert_instanceschemaGET /v2/insights/alert-instances?status=active&page=1&per_page=20returns 200 from api-servicepaginationobject /owner_uuid)Insightstag /parameters.ymlwith COBS-1289: Add Insights notification channels OpenAPI #1224 / COBS-1290: Add Insights alert rules OpenAPI #1225 (whichever merges last)Blocked by / ships after: COBS-1287 Edge routing.
Related: notification-channels draft #1224 (COBS-1289), alert-rules draft #1225 (COBS-1290).