Skip to content

chore: update control openapi spec#1468

Merged
MikeCarbone merged 2 commits into
mainfrom
control-openapi-spec-updates
Jun 3, 2026
Merged

chore: update control openapi spec#1468
MikeCarbone merged 2 commits into
mainfrom
control-openapi-spec-updates

Conversation

@knock-eng-bot
Copy link
Copy Markdown
Contributor

Automated PR created from GitHub Actions workflow from knocklabs/control release (v0.1.1435).

@vercel
Copy link
Copy Markdown

vercel Bot commented Jun 2, 2026

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

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Jun 3, 2026 2:03pm

Request Review

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: Automated OpenAPI spec update from control release v0.1.1435 that adds new Asset schemas and endpoint, renames target_audience_id to target_audience_key, and updates code examples.

Reasons

  • OpenAPI spec file (data/specs/mapi/openapi.yml) is modified, which can affect API reference rendering on the docs site
  • New API endpoint (/v1/assets) and schemas (Asset, PaginatedAssetResponse) are introduced, expanding the documented API surface
  • Field rename from target_audience_id to target_audience_key across multiple guide-related schemas and examples is a breaking change in the spec
  • Code examples in multiple languages (Node.js, Python, Go) are updated to reference guide.valid instead of guide.target_audience_id
  • Only 1 file changed and the author is a trusted bot (knock-eng-bot), which limits blast radius

Notes

  • Verify the target_audience_id to target_audience_key rename is intentional and aligns with the actual API behavior in control v0.1.1435
  • Confirm the code examples now printing guide.valid instead of guide.target_audience_id are correct — this changes what the example demonstrates
  • Check that the new /v1/assets endpoint renders correctly in the API reference documentation
  • The reordering of MessageTypeTextField and MessageTypeNumberField refs appears in three places — confirm this is intentional and not a spec generation artifact
Open in Web View Automation 

Sent by Cursor Automation: Docs PR classifier

@MikeCarbone MikeCarbone merged commit 4410680 into main Jun 3, 2026
5 checks passed
@MikeCarbone MikeCarbone deleted the control-openapi-spec-updates branch June 3, 2026 14:42
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