Skip to content

COBS-1289: Add Insights notification channels OpenAPI - #1224

Open
dmamidala-glitch wants to merge 6 commits into
digitalocean:mainfrom
dmamidala-glitch:cobs-1289-insights-notification-channels
Open

dmamidala-glitch wants to merge 6 commits into
digitalocean:mainfrom
dmamidala-glitch:cobs-1289-insights-notification-channels

Conversation

@dmamidala-glitch

@dmamidala-glitch dmamidala-glitch commented Sep 16, 2026 •

Copy link
Copy Markdown

Summary

  • Adds public OpenAPI for Insights notification channel CRUD under /v2/insights/notification-channels.
  • Documents the current API's protobuf enum values for channel_type: CHANNEL_TYPE_EMAIL, CHANNEL_TYPE_SLACK, and CHANNEL_TYPE_WEBHOOK.
  • Documents write-only/masked secrets (******** on read), page/per_page (default 20, max 200), links/meta list envelope, and scopes insights:read|create|update|delete.
  • PagerDuty and /test are intentionally omitted.

Test plan

  • make lint passes (0 Spectral errors)
  • Enum schemas and examples match the current staging API values
  • Align the RFC with the documented protobuf enum values
  • After merge, confirm docs regen publishes the new endpoints

Blocked by / ships after: COBS-1287 Edge routing.

Related: alert-rules draft #1225 (COBS-1290).

Document public CRUD for /v2/insights/notification-channels against the
api-service contract and Edge scopes from COBS-1287.

Co-authored-by: Cursor <cursoragent@cursor.com>
dmamidala-glitch and others added 3 commits September 16, 2026 14:26
Omit unsupported pagerduty channel type/config from the public spec.

Co-authored-by: Cursor <cursoragent@cursor.com>
Use lowercase channel types, write-only/masked secrets, and page/per_page
defaults from the Alerts Public Insights API RFC.

Co-authored-by: Cursor <cursoragent@cursor.com>
@dmamidala-glitch
dmamidala-glitch marked this pull request as ready for review September 16, 2026 11:57
dmamidala-glitch and others added 2 commits September 22, 2026 12:29
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant