Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions doc/compiled.json
Original file line number Diff line number Diff line change
Expand Up @@ -6758,7 +6758,7 @@
"/projects/{project_id}/figma_attachments/{figma_attachment_id}/keys/{id}": {
"delete": {
"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.\n\nThis endpoint is only available on plans that include the Figma Screenshots feature.\n",
"operationId": "figma_attachment/detach_from_key",
"tags": [
"Key's Figma attachments"
Expand Down Expand Up @@ -6788,23 +6788,28 @@
],
"responses": {
"204": {
"$ref": "#/components/responses/204"
"description": "The key was successfully detached from the Figma attachment. No content is returned."
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"422": {
"$ref": "#/components/responses/422"
},
"429": {
"$ref": "#/components/responses/429"
}
},
"x-code-samples": [
{
"lang": "Curl",
"source": "curl \"https://api.phrase.com/v2/projects/:project_id/figma_attachments/:figma_attachment_id/keys/:id\" \\\n -u USERNAME_OR_ACCESS_TOKEN \\\n -X DELETE \\\n -F branch=my-feature-branch \\\n -H 'Content-Type: application/json'"
},
{
"lang": "CLI v2",
"source": "phrase figma_attachment detach_from_key \\\n--project_id <project_id> \\\n--figma_attachment_id <figma_attachment_id> \\\n--id <id> \\\n--branch my-feature-branch \\\n--access_token <token>"
Expand Down
20 changes: 11 additions & 9 deletions paths/figma_attachment_keys/destroy.yaml
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
Expand All @@ -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.

Copy link
Copy Markdown
Collaborator

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

head(:no_content)

"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:

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why was this removed?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The 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

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The 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 \
Expand Down
Loading