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 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_runsto/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_betweencondition type addition (in the conditions enum) is intentional and documented if user-facing. - Review that removing the old
WorkflowRun/WorkflowRunDetailschemas and addingWorkflowRecipientRun/WorkflowRecipientRunDetaildoesn't leave any dangling$refreferences in the spec.
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.1402).