docs(openapi): tighten workspace API key description field (BE-1004)

[mattmillerai]

Summary

Aligns the OSS spec for the workspace API key endpoints with cloud's runtime contract from BE-1004.

Three small changes to openapi.yaml:

• createWorkspaceApiKey request body — add maxLength: 5000 to the description property (matches cloud's hub_profile.description Ent MaxLen(5000) convention; enforced cloud-side via handler check + Ent validator).
• 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").

Why

The workspace API keys schemas are tagged x-runtime: [cloud] — they document a cloud-only endpoint surface that OSS doesn't implement. Cloud's hand-written spec (services/ingest/openapi.yaml in Comfy-Org/cloud) was tightened in https://github.com/Comfy-Org/cloud/pull/3747 to reflect actual runtime behavior; this PR brings the upstream OSS contract in line so the daily vendor-sync bot can propagate the tightening back to cloud's vendor copy without drift.

Scope

Spec-only. No generated code or handlers in OSS to touch — OSS has no implementation of these endpoints.

Related

• Cloud PR: Comfy-Org/cloud#3747
• Linear: BE-1004

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 5789f01d-e834-4544-bac5-73e5a2ce5634

📥 Commits

Reviewing files that changed from the base of the PR and between cc4d711 and b1a02e2.

📒 Files selected for processing (1)

• openapi.yaml

---

📝 Walkthrough

Walkthrough

This PR updates the OpenAPI specification for the workspace API key endpoint to enforce consistent validation on the description field across request and response schemas. The request body description property gains a maximum length constraint of 5000 characters. Both response schemas—WorkspaceApiKey and WorkspaceApiKeyCreated—are updated to remove nullable semantics, enforce the same maximum length, and document that the field is always present in responses (populated with an empty string when omitted at creation). The WorkspaceApiKeyCreated schema additionally marks description as a required field.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and specifically describes the main change: tightening the workspace API key description field validation in the OpenAPI spec.
Description check	✅ Passed	The description is directly related to the changeset, providing detailed context about the schema updates, rationale, and alignment with cloud runtime behavior.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}