chore: update control openapi spec#1459
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Risk MEDIUM: Adds new field type schemas (color, list, number) to the Management API OpenAPI spec file.
Reasons
- Only one file changed:
data/specs/mapi/openapi.yml(an OpenAPI spec indata/specs/) - OpenAPI spec modifications can affect API reference rendering, triggering MEDIUM classification per policy
- Purely additive change (271 insertions, 0 deletions) — no existing schemas removed or modified
- Author is
knock-eng-bot, a trusted bot performing routine spec updates - No code, component, layout, or build configuration changes
Notes
- Verify that the new schemas (
MessageTypeColorField,MessageTypeListField,MessageTypeNumberField) render correctly in the API reference pages - Confirm the new
$refentries in theMessageTypePartialfields list are ordered consistently with existing conventions
Sent by Cursor Automation: Docs PR classifier
| - $ref: '#/components/schemas/MessageTypeNumberField' | ||
| - $ref: '#/components/schemas/MessageTypeTextField' | ||
| - $ref: '#/components/schemas/MessageTypeImageField' | ||
| - $ref: '#/components/schemas/MessageTypeColorField' |
There was a problem hiding this comment.
New schemas missing from stainless.yml for SDK generation
Medium Severity
Three new schemas (MessageTypeListField, MessageTypeNumberField, MessageTypeColorField) were added to openapi.yml but the corresponding model entries are missing from data/specs/mapi/stainless.yml. Every other MessageType*Field schema is registered in the $shared.models section of stainless.yml — these three need to be added there as well, and then the updated spec also needs to be checked into the Stainless platform (https://app.stainless.com/knock/knock-mapi/studio) so SDKs generate with the new types.
Triggered by learned rule: Stainless spec changes must also be published to Stainless platform
Reviewed by Cursor Bugbot for commit 8afe0fc. Configure here.
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
There are 2 total unresolved issues (including 1 from previous review).
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 20efadf. Configure here.
| nullable: true | ||
| type: array | ||
| x-struct: null | ||
| x-validate: null |
There was a problem hiding this comment.
Array property missing required items definition
Medium Severity
The default property in MessageTypeListField.settings is declared as type: array but lacks an items schema. In OpenAPI 3.0, items is required for array types. The existing MessageTypeMultiSelectField.settings.default correctly includes items. This omission can cause SDK code generators to error or produce incorrect types for the list field's default value.
Reviewed by Cursor Bugbot for commit 20efadf. Configure here.




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