Skip to content

chore: update switchboard openapi spec#1350

Open
knock-eng-bot wants to merge 1 commit intomainfrom
switchboard-openapi-spec-updates
Open

chore: update switchboard openapi spec#1350
knock-eng-bot wants to merge 1 commit intomainfrom
switchboard-openapi-spec-updates

Conversation

@knock-eng-bot
Copy link
Contributor

Automated PR created from GitHub Actions workflow from knocklabs/switchboard release (v0.1.1402).

@vercel
Copy link

vercel bot commented Mar 13, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Mar 13, 2026 4:45pm

Request Review

Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

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

Risk MEDIUM: Automated OpenAPI spec update renames "workflow runs" to "workflow recipient runs," replacing endpoints and schemas in data/specs/api/openapi.yml.

Reasons

  • Only one file changed (data/specs/api/openapi.yml), and no code, component, or config files are modified — ruling out HIGH risk.
  • OpenAPI spec files are modified, which triggers MEDIUM risk per classification rules (can affect API reference rendering).
  • The diff is substantial (513 additions, 498 deletions) with both new schemas and removed schemas, indicating a non-trivial structural change to the API spec.
  • Endpoints are renamed from /v1/workflow_runs to /v1/workflow_recipient_runs, which could break existing API reference links or documentation cross-references.
  • The change is automated from a known trusted bot (knock-eng-bot) via switchboard release v0.1.1402, reducing the likelihood of accidental errors.

Notes

  • Verify that any existing documentation pages or MDX content referencing the old "workflow runs" endpoints or operation IDs (listWorkflowRuns, getWorkflowRun) are updated to reflect the new "workflow recipient runs" naming.
  • Check that the API reference rendering correctly picks up the new tag name ("Workflow recipient runs") and that sidebar/navigation still works as expected.
  • Confirm the new is_between condition type addition (in the conditions enum) is intentional and documented if user-facing.
  • Review that removing the old WorkflowRun/WorkflowRunDetail schemas and adding WorkflowRecipientRun/WorkflowRecipientRunDetail doesn't leave any dangling $ref references in the spec.
Open in Web View Automation 

Sent by Cursor Automation: Docs PR classifier

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