Update OpenAPI spec - #9
Closed
alisalahio wants to merge 1 commit into
Closed
Conversation
skittlesaur
approved these changes
Jul 25, 2026
There was a problem hiding this comment.
Pull request overview
Automated refresh of the Instatus OpenAPI specification outputs (YAML + JSON), adding newly supported endpoints and normalizing/expanding monitor-related schemas so API clients can be generated against the latest surface area.
Changes:
- Adds
/v2/{page_id}/team-groupendpoints and related teammate/team-group schemas. - Adds cron monitor endpoints (
/{page_id}/monitors/cron,/monitors/cron/*) plus a set ofCronMonitor*schemas. - Refactors monitor location typing (introducing
MonitorLocationValue) and adjusts a few parameter/schema definitions.
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| instatus.yaml | Updates the canonical OpenAPI YAML: adds team-group + cron monitor paths/schemas and adjusts several existing path/parameter definitions. |
| instatus.json | Mirrors the same spec update in JSON form (paths/schemas/parameters aligned with the YAML version). |
Comments suppressed due to low confidence (1)
instatus.yaml:473
- The
Add an incident with a templatePOST operation is currently nested under/v1/{page_id}/incidents/{incident_id}(immediately after the DELETE operation) and reuses theincident_idpath parameter. This breaks the OpenAPI contract: the template endpoint path is missing, and the path-template variable/parameter name no longer matches the intended{template}segment.
post:
summary: Add an incident with a template
description: Create a new incident using a template
tags:
- Incidents
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+2249
to
+2253
| - in: path | ||
| name: id | ||
| required: true | ||
| description: The ping slug of the cron monitor | ||
| schema: |
Comment on lines
3296
to
3300
| "in": "path", | ||
| "name": "page_id", | ||
| "name": "id", | ||
| "required": true, | ||
| "description": "The ping slug of the cron monitor", | ||
| "schema": { |
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
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.
Automated OpenAPI spec update.