fix(API): improve delete /projects/{project_id}/figma_attachments/{figma_attachment_id}/keys/{id} documentation#1191
Open
Stephen Lumenta (sbl) wants to merge 10 commits into
Conversation
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)
…igma_attachment_id}/keys/{id} documentation
Stephen Lumenta (sbl)
added
the
developer-hub-api-quality
Contributor
API changelog (oasdiff)Doc-only edits (descriptions, examples) do not appear here. |
Stephen Lumenta (sbl)
changed the title
…/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>
Review feedback: error response descriptions should stay in the shared responses.yaml for consistency, not be re-authored inline per operation. Under OpenAPI 3.0 a description sibling of $ref is ignored anyway, so the inline text never rendered. Strip the inline $ref-sibling response descriptions (now bare $refs); the shared response owns the wording. Genuinely custom (non-$ref) response bodies are left intact. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Strings convention: never hand-author Curl or CLI v2 samples. Mintlify renders the request sample (curl + the multi-language playground) and the response from the OpenAPI operation itself, so a hand-written x-code-samples block drifts and overrides the correct auto-generated one; a CLI v2 sample is not spec-derivable at all. Remove the block so Mintlify renders. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…figma-attachment-from-a-key
…figma-attachment-from-a-key
jablan
reviewed
Jun 25, 2026
| "$ref": "../../responses.yaml#/422" | ||
| "429": | ||
| "$ref": "../../responses.yaml#/429" | ||
| x-code-samples: |
Contributor
Author
There was a problem hiding this comment.
same comment to before. this is automatically rendered by mintlify and removes the duplication. see this PR for reference: https://github.com/Phrase-Engineering/strings-app/pull/17973
Collaborator
There was a problem hiding this comment.
I'll have to discuss this with the team, I don't think that was a good approach. I think we should keep strings-specific examples, just not sure whether they should be generated along with the clients, using AI, or manually as before.
New strings rubric rule: Mintlify auto-generates the request curl, so a hand-written Curl sample is redundant and overrides it, but a CLI v2 sample cannot be derived from the spec and must be preserved. This PR originally removed the whole x-code-samples block; restore the CLI v2 entry (Curl stays dropped). compiled.json regenerated via make bundle.
jablan
reviewed
Jul 1, 2026
| responses: | ||
| "204": | ||
| "$ref": "../../responses.yaml#/204" | ||
| description: The key was successfully detached from the Figma attachment. No content is returned. |
Collaborator
There was a problem hiding this comment.
hm is there content returned or not? there's the content section below
There was a problem hiding this comment.
head(:no_content)
| responses: | ||
| "204": | ||
| "$ref": "../../responses.yaml#/204" | ||
| description: The key was successfully detached from the Figma attachment. No content is returned. |
There was a problem hiding this comment.
head(:no_content)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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