-
Notifications
You must be signed in to change notification settings - Fork 8
fix(API): improve delete /projects/{project_id}/figma_attachments/{figma_attachment_id}/keys/{id} documentation #1191
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
69f490e
e01a59a
d338c5b
f69988e
83d4207
4f2952b
d370ea5
1492855
3036575
5c7dfb3
b36eb9e
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,9 @@ | ||
| --- | ||
| summary: Detach the Figma attachment from a key | ||
| description: Detach the Figma attachment from a key | ||
| description: | | ||
| Removes the many-to-many association between a translation key and a Figma attachment. Neither the translation key nor the Figma attachment is deleted — only the link between them is removed. Use this when a key no longer corresponds to the design element represented by the Figma frame, or when cleaning up stale key associations after a design update. | ||
|
|
||
| This endpoint is only available on plans that include the Figma Screenshots feature. | ||
| operationId: figma_attachment/detach_from_key | ||
| tags: | ||
| - Key's Figma attachments | ||
|
|
@@ -17,21 +20,20 @@ parameters: | |
| type: string | ||
| responses: | ||
| "204": | ||
| "$ref": "../../responses.yaml#/204" | ||
| description: The key was successfully detached from the Figma attachment. No content is returned. | ||
| "400": | ||
| "$ref": "../../responses.yaml#/400" | ||
| "401": | ||
| "$ref": "../../responses.yaml#/401" | ||
| "403": | ||
| "$ref": "../../responses.yaml#/403" | ||
| "404": | ||
| "$ref": "../../responses.yaml#/404" | ||
| "422": | ||
| "$ref": "../../responses.yaml#/422" | ||
| "429": | ||
| "$ref": "../../responses.yaml#/429" | ||
| x-code-samples: | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. why was this removed?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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. |
||
| - lang: Curl | ||
| source: |- | ||
| curl "https://api.phrase.com/v2/projects/:project_id/figma_attachments/:figma_attachment_id/keys/:id" \ | ||
| -u USERNAME_OR_ACCESS_TOKEN \ | ||
| -X DELETE \ | ||
| -F branch=my-feature-branch \ | ||
| -H 'Content-Type: application/json' | ||
| - lang: CLI v2 | ||
| source: |- | ||
| phrase figma_attachment detach_from_key \ | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
hm is there content returned or not? there's the content section below
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.