Skip to content

Update OpenAPI spec - #9

Closed
alisalahio wants to merge 1 commit into
mainfrom
sync-openapi
Closed

Update OpenAPI spec#9
alisalahio wants to merge 1 commit into
mainfrom
sync-openapi

Conversation

@alisalahio

Copy link
Copy Markdown
Member

Automated OpenAPI spec update.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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-group endpoints and related teammate/team-group schemas.
  • Adds cron monitor endpoints (/{page_id}/monitors/cron, /monitors/cron/*) plus a set of CronMonitor* 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 template POST operation is currently nested under /v1/{page_id}/incidents/{incident_id} (immediately after the DELETE operation) and reuses the incident_id path 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 thread instatus.yaml
Comment on lines +2249 to +2253
- in: path
name: id
required: true
description: The ping slug of the cron monitor
schema:
Comment thread instatus.json
Comment on lines 3296 to 3300
"in": "path",
"name": "page_id",
"name": "id",
"required": true,
"description": "The ping slug of the cron monitor",
"schema": {
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.

3 participants