Commit cc4d711
authored
feat(openapi): add optional description field to workspace API key schemas (Comfy-Org#13993)
* feat(openapi): add optional description field to workspace API key schemas
Add an optional `description` property (type: string) to three
workspace API key schemas in openapi.yaml:
- Inline request body of createWorkspaceApiKey (POST /api/workspace/api-keys)
- WorkspaceApiKey (list/info schema)
- WorkspaceApiKeyCreated (creation response schema)
The field is not added to any `required` array, making it fully
backward-compatible with existing clients.
Refs: BE-1005, BE-1004
Co-authored-by: Matt Miller <mattmillerai@users.noreply.github.com>
* fix(openapi): mark description nullable in workspace API key response schemas
Per CodeRabbit review on PR Comfy-Org#13993: the underlying DB column is nullable
varchar (default ''), so the response schemas should permit null to match
stored data reality. Without nullable: true the OpenAPI contract would
require coercion on the handler side or risk a contract violation.
Request schema unchanged — clients shouldn't be sending null on create.1 parent 626b082 commit cc4d711
1 file changed
Lines changed: 11 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4160 | 4160 | | |
4161 | 4161 | | |
4162 | 4162 | | |
| 4163 | + | |
| 4164 | + | |
| 4165 | + | |
4163 | 4166 | | |
4164 | 4167 | | |
4165 | 4168 | | |
| |||
7682 | 7685 | | |
7683 | 7686 | | |
7684 | 7687 | | |
| 7688 | + | |
| 7689 | + | |
| 7690 | + | |
| 7691 | + | |
7685 | 7692 | | |
7686 | 7693 | | |
7687 | 7694 | | |
| |||
7708 | 7715 | | |
7709 | 7716 | | |
7710 | 7717 | | |
| 7718 | + | |
| 7719 | + | |
| 7720 | + | |
| 7721 | + | |
7711 | 7722 | | |
7712 | 7723 | | |
7713 | 7724 | | |
| |||
0 commit comments