diff --git a/doc/compiled.json b/doc/compiled.json index 50246a1c..17827041 100644 --- a/doc/compiled.json +++ b/doc/compiled.json @@ -21706,7 +21706,7 @@ }, "delete": { "summary": "Delete a screenshot", - "description": "Delete an existing screenshot.", + "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", "operationId": "screenshot/delete", "tags": [ "Screenshots" @@ -21742,8 +21742,7 @@ "$ref": "#/components/responses/401" }, "403": { - "$ref": "#/components/responses/403", - "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." + "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" @@ -21756,10 +21755,6 @@ } }, "x-code-samples": [ - { - "lang": "Curl", - "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'" - }, { "lang": "CLI v2", "source": "phrase screenshots delete \\\n--project_id \\\n--id \\\n--branch my-feature-branch \\\n--access_token " diff --git a/paths/screenshots/destroy.yaml b/paths/screenshots/destroy.yaml index df35b034..161018d1 100644 --- a/paths/screenshots/destroy.yaml +++ b/paths/screenshots/destroy.yaml @@ -1,6 +1,7 @@ --- summary: Delete a screenshot -description: Delete an existing screenshot. +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. operationId: screenshot/delete tags: - Screenshots @@ -19,25 +20,17 @@ responses: "$ref": "../../responses.yaml#/204" '400': "$ref": "../../responses.yaml#/400" - '404': - "$ref": "../../responses.yaml#/404" '401': "$ref": "../../responses.yaml#/401" '403': "$ref": "../../responses.yaml#/403" - 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. + '404': + "$ref": "../../responses.yaml#/404" '422': "$ref": "../../responses.yaml#/422" '429': "$ref": "../../responses.yaml#/429" x-code-samples: -- lang: Curl - source: |- - curl "https://api.phrase.com/v2/projects/:project_id/screenshots/:id" \ - -u USERNAME_OR_ACCESS_TOKEN \ - -X DELETE \ - -d '{"branch":"my-feature-branch"}' \ - -H 'Content-Type: application/json' - lang: CLI v2 source: |- phrase screenshots delete \