Skip to content

Commit 6887165

Browse files
authored
docs(openapi): tighten workspace API key description field (BE-1004) (Comfy-Org#13996)
Aligns the OSS spec with the cloud-side BE-1004 contract: - createWorkspaceApiKey request body: add maxLength: 5000 to the description property (matches cloud's hub_profile.description MaxLen(5000) convention; enforced cloud-side via handler check). - WorkspaceApiKey + WorkspaceApiKeyCreated response schemas: mark description as required (cloud's handler always populates the field, defaulting to empty string when not supplied on create), drop nullable: true, add maxLength: 5000 for symmetry, and clarify the doc string ("Always present in responses; empty string when no description was supplied on create"). Both schemas are tagged x-runtime: [cloud] at the schema level so the tightening is correctly scoped — OSS-only implementations are not required to honor the workspace API keys endpoints at all. Related cloud PR: Comfy-Org/cloud#3747
1 parent cc4d711 commit 6887165

1 file changed

Lines changed: 8 additions & 5 deletions

File tree

openapi.yaml

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4162,7 +4162,8 @@ paths:
41624162
description: Display name for the API key
41634163
description:
41644164
type: string
4165-
description: User-provided description for the key
4165+
description: User-provided description of the key's purpose
4166+
maxLength: 5000
41664167
responses:
41674168
"201":
41684169
description: API key created
@@ -7680,15 +7681,16 @@ components:
76807681
required:
76817682
- id
76827683
- name
7684+
- description
76837685
properties:
76847686
id:
76857687
type: string
76867688
name:
76877689
type: string
76887690
description:
76897691
type: string
7690-
nullable: true
7691-
description: User-provided description
7692+
maxLength: 5000
7693+
description: User-provided description of the key's purpose. Always present in responses; empty string when no description was supplied on create.
76927694
prefix:
76937695
type: string
76947696
description: First few characters of the key for identification
@@ -7709,6 +7711,7 @@ components:
77097711
required:
77107712
- id
77117713
- name
7714+
- description
77127715
- key
77137716
properties:
77147717
id:
@@ -7717,8 +7720,8 @@ components:
77177720
type: string
77187721
description:
77197722
type: string
7720-
nullable: true
7721-
description: User-provided description
7723+
maxLength: 5000
7724+
description: User-provided description of the key's purpose. Always present in responses; empty string when no description was supplied on create.
77227725
key:
77237726
type: string
77247727
description: Full API key value (only returned on creation)

0 commit comments

Comments
 (0)