Skip to content

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

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

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

Conversation

@sbl

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

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

@sbl
docs(API): improve DELETE figma_attachments/:id/keys/:id documentation
69f490e 
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
feat(API): improve delete /projects/{project_id}/figma_attachments/{f…
e01a59a 
…igma_attachment_id}/keys/{id} documentation
@sbl Stephen Lumenta (sbl) added the developer-hub-api-quality API doc quality fix from the API Grader label Jun 15, 2026
@github-actions

github-actions Bot commented Jun 15, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

API changelog (oasdiff)

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

17 changes: 0 error, 3 warning, 14 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-property-became-required] at doc/compiled.json
	in API GET /formats
		the response property `items/api_name` became required for the status `200`

info	[response-property-became-required] at doc/compiled.json
	in API GET /formats
		the response property `items/default_encoding` became required for the status `200`

info	[response-property-became-required] at doc/compiled.json
	in API GET /formats
		the response property `items/default_file` became required for the status `200`

info	[response-property-became-required] at doc/compiled.json
	in API GET /formats
		the response property `items/description` became required for the status `200`

info	[response-property-became-required] at doc/compiled.json
	in API GET /formats
		the response property `items/exportable` became required for the status `200`

info	[response-property-became-required] at doc/compiled.json
	in API GET /formats
		the response property `items/extension` became required for the status `200`

info	[response-property-became-required] at doc/compiled.json
	in API GET /formats
		the response property `items/importable` became required for the status `200`

info	[response-property-became-required] at doc/compiled.json
	in API GET /formats
		the response property `items/includes_locale_information` became required for the status `200`

info	[response-property-became-required] at doc/compiled.json
	in API GET /formats
		the response property `items/name` became required for the status `200`

info	[response-property-became-required] at doc/compiled.json
	in API GET /formats
		the response property `items/renders_default_locale` became required for the status `200`

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`

@sbl Stephen Lumenta (sbl) changed the title feat(API): improve delete /projects/{project_id}/figma_attachments/{figma_attachment_id}/keys/{id} documentation fix(API): improve delete /projects/{project_id}/figma_attachments/{figma_attachment_id}/keys/{id} documentation Jun 17, 2026
@sbl @claude
fix(API): clean up delete .../figma_attachments/{figma_attachment_id}…
d338c5b 
…/keys/{id}

Apply the batch review conventions:
- Move the per-status 'Errors' table out of the top-level description and
  onto the response objects (401/403/404/422/429 now carry their own
  description), keeping only the endpoint purpose and feature-availability
  note in the description.
- Drop the '# Expected response: HTTP 204 ...' trailer from the curl
  sample so it shows only the request.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

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

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@sbl