Skip to content

feat(API): improve post /projects/{project_id}/figma_attachments/{figma_attachment_id}/keys documentation#1184

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

feat(API): improve post /projects/{project_id}/figma_attachments/{figma_attachment_id}/keys documentation#1184
Stephen Lumenta (sbl) wants to merge 1 commit into
mainfrom
devex-118-keys-figma-attachments-attach-figma-key-v2

Conversation

@sbl

Copy link
Copy Markdown
Contributor

Improves the documentation for post /projects/{project_id}/figma_attachments/{figma_attachment_id}/keys: 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.

Closes DEVEX-118

🤖 Generated with Claude Code

@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.

5 changes: 1 error, 1 warning, 3 info
error	[request-body-added-required] at doc/compiled.json
	in API POST /projects/{project_id}/figma_attachments/{figma_attachment_id}/keys
		added required request body

warning	[request-parameter-removed] at doc/compiled.json
	in API POST /projects/{project_id}/figma_attachments/{figma_attachment_id}/keys
		deleted the `path` request parameter `id`
		This is a warning because some clients may return an error when receiving an unexpected parameter. It is recommended to deprecate the parameter first.

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

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

info	[response-non-success-status-added] at doc/compiled.json
	in API POST /projects/{project_id}/figma_attachments/{figma_attachment_id}/keys
		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