Skip to content

feat(API): improve delete /projects/{project_id}/figma_attachments/{figma_attachment_id}/keys/{id} documentation#1191

Open
Stephen Lumenta (sbl) wants to merge 2 commits into
mainfrom
devex-118-keys-figma-attachments-detach-the-figma-attachment-from-a-key
Open

feat(API): improve delete /projects/{project_id}/figma_attachments/{figma_attachment_id}/keys/{id} documentation#1191
Stephen Lumenta (sbl) wants to merge 2 commits into
mainfrom
devex-118-keys-figma-attachments-detach-the-figma-attachment-from-a-key

Conversation

@sbl

Copy link
Copy Markdown
Contributor

Improves the documentation for delete /projects/{project_id}/figma_attachments/{figma_attachment_id}/keys/{id}: sharper descriptions, parameter docs, error responses, and usage examples.

Drafted with AI assistance and grounded in the API implementation. Please review for technical accuracy before merging; nothing is merged automatically.

🤖 Generated with Claude Code

Adds conceptual description (why/model/pitfalls including that detach
does not delete the attachment), documents 401/403/422 responses with
causes and remediation (feature gate, policy, already-detached error),
and improves branch parameter description.

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 15, 2026
@github-actions

Copy link
Copy Markdown
Contributor

API changelog (oasdiff)

Doc-only edits (descriptions, examples) do not appear here.

7 changes: 0 error, 3 warning, 4 info
warning	[optional-response-header-removed] at doc/compiled.json
	in API DELETE /projects/{project_id}/figma_attachments/{figma_attachment_id}/keys/{id}
		the optional response header `x-rate-limit-limit` removed for the status `204`

warning	[optional-response-header-removed] at doc/compiled.json
	in API DELETE /projects/{project_id}/figma_attachments/{figma_attachment_id}/keys/{id}
		the optional response header `x-rate-limit-remaining` removed for the status `204`

warning	[optional-response-header-removed] at doc/compiled.json
	in API DELETE /projects/{project_id}/figma_attachments/{figma_attachment_id}/keys/{id}
		the optional response header `x-rate-limit-reset` removed for the status `204`

info	[response-media-type-added] at doc/compiled.json
	in API DELETE /projects/{project_id}/figma_attachments/{figma_attachment_id}/keys/{id}
		added the media type `application/json` for the response with the status `204`

info	[response-non-success-status-added] at doc/compiled.json
	in API DELETE /projects/{project_id}/figma_attachments/{figma_attachment_id}/keys/{id}
		added the non-success response with the status `401`

info	[response-non-success-status-added] at doc/compiled.json
	in API DELETE /projects/{project_id}/figma_attachments/{figma_attachment_id}/keys/{id}
		added the non-success response with the status `403`

info	[response-non-success-status-added] at doc/compiled.json
	in API DELETE /projects/{project_id}/figma_attachments/{figma_attachment_id}/keys/{id}
		added the non-success response with the status `422`

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