Commit 6887165
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#37471 parent cc4d711 commit 6887165
1 file changed
Lines changed: 8 additions & 5 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4162 | 4162 | | |
4163 | 4163 | | |
4164 | 4164 | | |
4165 | | - | |
| 4165 | + | |
| 4166 | + | |
4166 | 4167 | | |
4167 | 4168 | | |
4168 | 4169 | | |
| |||
7680 | 7681 | | |
7681 | 7682 | | |
7682 | 7683 | | |
| 7684 | + | |
7683 | 7685 | | |
7684 | 7686 | | |
7685 | 7687 | | |
7686 | 7688 | | |
7687 | 7689 | | |
7688 | 7690 | | |
7689 | 7691 | | |
7690 | | - | |
7691 | | - | |
| 7692 | + | |
| 7693 | + | |
7692 | 7694 | | |
7693 | 7695 | | |
7694 | 7696 | | |
| |||
7709 | 7711 | | |
7710 | 7712 | | |
7711 | 7713 | | |
| 7714 | + | |
7712 | 7715 | | |
7713 | 7716 | | |
7714 | 7717 | | |
| |||
7717 | 7720 | | |
7718 | 7721 | | |
7719 | 7722 | | |
7720 | | - | |
7721 | | - | |
| 7723 | + | |
| 7724 | + | |
7722 | 7725 | | |
7723 | 7726 | | |
7724 | 7727 | | |
| |||
0 commit comments