Skip to content

feat(KNO-12791): Add workflow recipient runs to docs#1398

Merged
andy-knock merged 1 commit into
mainfrom
andy-kno-12791-docssdks-add-workflow-recipient-run-endpoints-to-openapi
Apr 22, 2026
Merged

feat(KNO-12791): Add workflow recipient runs to docs#1398
andy-knock merged 1 commit into
mainfrom
andy-kno-12791-docssdks-add-workflow-recipient-run-endpoints-to-openapi

Conversation

@andy-knock
Copy link
Copy Markdown
Contributor

@andy-knock andy-knock commented Apr 21, 2026

Description

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

Screenshots

Screenshot 2026-04-21 at 12 24 53 PM Screenshot 2026-04-21 at 12 24 50 PM Screenshot 2026-04-21 at 12 24 47 PM Screenshot 2026-04-21 at 12 24 43 PM Screenshot 2026-04-21 at 12 24 39 PM ![Uploading Screenshot 2026-04-21 at 12.24.35 PM.png…]()

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 21, 2026

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

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Apr 22, 2026 5:22pm

Request Review

@linear
Copy link
Copy Markdown

linear Bot commented Apr 21, 2026

Copy link
Copy Markdown
Contributor Author

andy-knock commented Apr 21, 2026

This stack of pull requests is managed by Graphite. Learn more about stacking.

@andy-knock andy-knock force-pushed the andy-kno-12791-docssdks-add-workflow-recipient-run-endpoints-to-openapi branch from 00f465a to 29fbb6b Compare April 21, 2026 14:21
@andy-knock andy-knock marked this pull request as ready for review April 21, 2026 16:30
@andy-knock andy-knock changed the base branch from main to graphite-base/1398 April 21, 2026 16:30
@andy-knock andy-knock force-pushed the andy-kno-12791-docssdks-add-workflow-recipient-run-endpoints-to-openapi branch from 29fbb6b to 48ca9e9 Compare April 21, 2026 16:30
@andy-knock andy-knock changed the base branch from graphite-base/1398 to fix-lockfile April 21, 2026 16:30
Copy link
Copy Markdown

@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: 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 new workflow_recipient_runs entry, which affects API reference page ordering
  • Two OpenAPI spec files modified (data/specs/api/customizations.yml and data/specs/api/stainless.yml) — these define a new API resource and can affect API reference rendering
  • .vscode/settings.json modified — 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/.ts component, layout, or lib files are modified, so no HIGH risk triggers apply

Notes

  • Verify the new workflow_recipient_runs sidebar entry renders correctly and links to the expected API reference page
  • Confirm the OpenAPI spec additions (WorkflowRecipientRun, WorkflowRecipientRunDetail, WorkflowRecipientRunEvent schemas) 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_runs and GET /v1/workflow_recipient_runs/{id}) render properly in the API reference UI
  • The .vscode/settings.json change is a team DX preference — confirm this is intentional to include in the repo
Open in Web View Automation 

Sent by Cursor Automation: Docs PR classifier

Copy link
Copy Markdown

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

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ 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.

Comment thread next-env.d.ts Outdated
@andy-knock andy-knock changed the base branch from fix-lockfile to main April 21, 2026 21:53
@andy-knock andy-knock force-pushed the andy-kno-12791-docssdks-add-workflow-recipient-run-endpoints-to-openapi branch from 48ca9e9 to db48716 Compare April 21, 2026 21:53
@andy-knock andy-knock requested review from a team, connorlindsey and kylemcd and removed request for a team April 21, 2026 21:54
Copy link
Copy Markdown
Contributor

@rachael-t rachael-t left a comment

Choose a reason for hiding this comment

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

Thank you for working on this 🙏 only thing is the bugbot comment

Comment thread next-env.d.ts Outdated
@andy-knock andy-knock force-pushed the andy-kno-12791-docssdks-add-workflow-recipient-run-endpoints-to-openapi branch from db48716 to eefa70a Compare April 22, 2026 17:19
@andy-knock
Copy link
Copy Markdown
Contributor Author

andy-knock commented Apr 22, 2026

Thank you for working on this 🙏 only thing is the bugbot comment

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.

Copy link
Copy Markdown
Contributor

@rachael-t rachael-t left a comment

Choose a reason for hiding this comment

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

@andy-knock sorry, it was just the last one about the next-env.d.ts file that you just changed 👍

@andy-knock
Copy link
Copy Markdown
Contributor Author

  • vscode/settings.json

technically, the last point was actually about a diff I introduced to vscode/settings.json, because when copy pasting in the yaml files (from the stainless yaml file manually) my editor likes correcting all the single quotes to double quotes and I was trying to prevent that to prevent a massive file diff

@andy-knock andy-knock merged commit 6a10b96 into main Apr 22, 2026
6 checks passed
@andy-knock andy-knock deleted the andy-kno-12791-docssdks-add-workflow-recipient-run-endpoints-to-openapi branch April 22, 2026 18:21
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.

2 participants