Skip to content

Commit 52dcc03

Browse files
sblclaude
andauthored
docs(API): improve delete /projects/{project_id}/screenshots/{id} documentation (#1186)
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent a0b85f7 commit 52dcc03

2 files changed

Lines changed: 6 additions & 18 deletions

File tree

doc/compiled.json

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21776,7 +21776,7 @@
2177621776
},
2177721777
"delete": {
2177821778
"summary": "Delete a screenshot",
21779-
"description": "Delete an existing screenshot.",
21779+
"description": "Permanently removes a screenshot and all its associated markers from the project. Use this when you need to fully remove a screenshot that is no longer relevant — for example, after a UI redesign renders the captured screen obsolete. This is a hard delete: the screenshot record and every key-to-region marker linked to it are destroyed together and cannot be recovered.\n",
2178021780
"operationId": "screenshot/delete",
2178121781
"tags": [
2178221782
"Screenshots"
@@ -21812,8 +21812,7 @@
2181221812
"$ref": "#/components/responses/401"
2181321813
},
2181421814
"403": {
21815-
"$ref": "#/components/responses/403",
21816-
"description": "Forbidden. Returned when the access token lacks the `write` scope, when the requesting user is not allowed to delete this screenshot, or when the account does not have the Attachable Screenshots feature."
21815+
"$ref": "#/components/responses/403"
2181721816
},
2181821817
"404": {
2181921818
"$ref": "#/components/responses/404"
@@ -21826,10 +21825,6 @@
2182621825
}
2182721826
},
2182821827
"x-code-samples": [
21829-
{
21830-
"lang": "Curl",
21831-
"source": "curl \"https://api.phrase.com/v2/projects/:project_id/screenshots/:id\" \\\n -u USERNAME_OR_ACCESS_TOKEN \\\n -X DELETE \\\n -d '{\"branch\":\"my-feature-branch\"}' \\\n -H 'Content-Type: application/json'"
21832-
},
2183321828
{
2183421829
"lang": "CLI v2",
2183521830
"source": "phrase screenshots delete \\\n--project_id <project_id> \\\n--id <id> \\\n--branch my-feature-branch \\\n--access_token <token>"

paths/screenshots/destroy.yaml

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
summary: Delete a screenshot
3-
description: Delete an existing screenshot.
3+
description: |
4+
Permanently removes a screenshot and all its associated markers from the project. Use this when you need to fully remove a screenshot that is no longer relevant — for example, after a UI redesign renders the captured screen obsolete. This is a hard delete: the screenshot record and every key-to-region marker linked to it are destroyed together and cannot be recovered.
45
operationId: screenshot/delete
56
tags:
67
- Screenshots
@@ -19,25 +20,17 @@ responses:
1920
"$ref": "../../responses.yaml#/204"
2021
'400':
2122
"$ref": "../../responses.yaml#/400"
22-
'404':
23-
"$ref": "../../responses.yaml#/404"
2423
'401':
2524
"$ref": "../../responses.yaml#/401"
2625
'403':
2726
"$ref": "../../responses.yaml#/403"
28-
description: Forbidden. Returned when the access token lacks the `write` scope, when the requesting user is not allowed to delete this screenshot, or when the account does not have the Attachable Screenshots feature.
27+
'404':
28+
"$ref": "../../responses.yaml#/404"
2929
'422':
3030
"$ref": "../../responses.yaml#/422"
3131
'429':
3232
"$ref": "../../responses.yaml#/429"
3333
x-code-samples:
34-
- lang: Curl
35-
source: |-
36-
curl "https://api.phrase.com/v2/projects/:project_id/screenshots/:id" \
37-
-u USERNAME_OR_ACCESS_TOKEN \
38-
-X DELETE \
39-
-d '{"branch":"my-feature-branch"}' \
40-
-H 'Content-Type: application/json'
4134
- lang: CLI v2
4235
source: |-
4336
phrase screenshots delete \

0 commit comments

Comments
 (0)