Skip to content

chore: update switchboard openapi spec#1523

Open
knock-eng-bot wants to merge 4 commits into
mainfrom
switchboard-openapi-spec-updates
Open

chore: update switchboard openapi spec#1523
knock-eng-bot wants to merge 4 commits into
mainfrom
switchboard-openapi-spec-updates

Conversation

@knock-eng-bot

Copy link
Copy Markdown
Contributor

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

@vercel

vercel Bot commented Jul 6, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Jul 10, 2026 3:18pm

Request Review

@cursor cursor Bot 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.

Risk MEDIUM: Automated OpenAPI spec update removing bracket ([]) suffixes from query parameter names across 24 API endpoints.

Reasons

  • Only one file changed (data/specs/api/openapi.yml), which is an OpenAPI spec file — this triggers the MEDIUM risk rule for spec modifications.
  • The change is a systematic find-and-replace (24 additions, 24 deletions) renaming parameters like include[]include, status[]status, etc.
  • Author is knock-eng-bot, a trusted bot performing routine spec syncs.
  • No code, layout, component, or configuration files are modified.
  • The diff is small and mechanical, but query parameter naming changes can affect how the API reference renders and how developers construct API requests.

Notes

  • Verify that the API reference pages render array query parameters correctly after removing the [] suffix — the spec still declares these as type: array with items, so the rendering engine should handle them, but it's worth a spot check.
  • Confirm that any code examples or SDK snippets referencing these parameter names (e.g. status[]) are updated consistently elsewhere if needed.
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants