chore: update switchboard openapi spec#1523
Open
knock-eng-bot wants to merge 4 commits into
Open
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
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 astype: arraywithitems, 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.
Sent by Cursor Automation: Docs PR classifier
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 PR created from GitHub Actions workflow from knocklabs/switchboard release (v0.1.1581).