feat(KNO-12791): Add workflow recipient runs to docs#1398
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
00f465a to
29fbb6b
Compare
29fbb6b to
48ca9e9
Compare
There was a problem hiding this comment.
Risk MEDIUM: Adds new workflow recipient runs resource to the API docs via OpenAPI spec and sidebar navigation changes.
Reasons
- Sidebar navigation file modified (
data/sidebars/apiOverviewSidebar.ts) — adds a newworkflow_recipient_runsentry, which affects API reference page ordering - Two OpenAPI spec files modified (
data/specs/api/customizations.ymlanddata/specs/api/stainless.yml) — these define a new API resource and can affect API reference rendering .vscode/settings.jsonmodified — low-risk IDE config change (disables YAML format-on-save), but not a build/deploy config- Small diff size (22 additions, 2 deletions across 4 meaningful files) keeps this from being HIGH risk
- No
.tsx/.tscomponent, layout, or lib files are modified, so no HIGH risk triggers apply
Notes
- Verify the new
workflow_recipient_runssidebar entry renders correctly and links to the expected API reference page - Confirm the OpenAPI spec additions (
WorkflowRecipientRun,WorkflowRecipientRunDetail,WorkflowRecipientRunEventschemas) are present in the generated spec — the customizations and stainless YAML reference these schemas but they must exist in the base spec - Check that the new API endpoints (
GET /v1/workflow_recipient_runsandGET /v1/workflow_recipient_runs/{id}) render properly in the API reference UI - The
.vscode/settings.jsonchange is a team DX preference — confirm this is intentional to include in the repo
Sent by Cursor Automation: Docs PR classifier
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 48ca9e9. Configure here.
48ca9e9 to
db48716
Compare
rachael-t
left a comment
There was a problem hiding this comment.
Thank you for working on this 🙏 only thing is the bugbot comment
db48716 to
eefa70a
Compare
Which part are you referring to? The first note is verified as per the screenshots. The second note is verified (in the scope of this PR) as the screenshots show the doc pages for those objects in the spec The third note idk what that even refers to, in the context of this PR I guess they would refer to the things referenced by the last two screenshots. The last item is valid and an accidental change that I reverted. |
rachael-t
left a comment
There was a problem hiding this comment.
@andy-knock sorry, it was just the last one about the next-env.d.ts file that you just changed 👍
technically, the last point was actually about a diff I introduced to |




Description
Add docs for workflow recipient runs. Copy pasta yml from stainless.
Screenshots