Skip to content

docs(API): improve POST figma_attachments/:id/keys documentation#1175

Open
Stephen Lumenta (sbl) wants to merge 1 commit into
mainfrom
devex-118-keys-figma-attachments-attach-the-figma-attachment-to-a-key
Open

docs(API): improve POST figma_attachments/:id/keys documentation#1175
Stephen Lumenta (sbl) wants to merge 1 commit into
mainfrom
devex-118-keys-figma-attachments-attach-the-figma-attachment-to-a-key

Conversation

@sbl

@sbl Stephen Lumenta (sbl) commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

Improves the documentation for POST /projects/:project_id/figma_attachments/:figma_attachment_id/keys (attach Figma attachment to key).

Changes

  • Adds conceptual description: what the operation does, why/when to use it, the feature-gate model, authorization requirements, and pitfalls
  • Documents 401, 403 (with feature-gate explanation), and 422 responses with causes and remediation
  • Improves branch parameter description

All changes are spec-layer only (paths/figma_attachment_keys/create.yaml + compiled bundle). No Ruby source edits.

Part of DEVEX-118.

Drafted with AI assistance and grounded in the strings-app source. Please review for technical accuracy before merging; nothing is merged automatically.

🤖 Generated with Claude Code

Adds conceptual description (why/model/pitfalls), documents 401/403/422
responses with causes and remediation (feature gate, policy, duplicate
attachment), improves branch parameter description, and fixes vocabulary.

Part of DEVEX-118.

🤖 Generated with Claude Code (claude-sonnet-4-6)
@sbl Stephen Lumenta (sbl) added the developer-hub-api-quality API doc quality fix from the API Grader label Jun 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

developer-hub-api-quality API doc quality fix from the API Grader

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant