diff --git a/doc/compiled.json b/doc/compiled.json index 50246a1c..af8b7416 100644 --- a/doc/compiled.json +++ b/doc/compiled.json @@ -21522,7 +21522,7 @@ "/projects/{project_id}/screenshots/{id}": { "get": { "summary": "Get a single screenshot", - "description": "Get details on a single screenshot for a given project.", + "description": "Returns a single screenshot belonging to the specified project. Use this to retrieve the screenshot's name, description, hosted image URL, and marker count after uploading, or before creating, updating, or inspecting its markers. The response is a synchronous, idempotent read — repeated calls return the same record without side effects.\n\nThe Attachable Screenshots feature must be enabled on the account.\n", "operationId": "screenshot/show", "tags": [ "Screenshots" @@ -21542,6 +21542,7 @@ "example": "my-feature-branch", "name": "branch", "in": "query", + "required": false, "schema": { "type": "string" } @@ -21576,8 +21577,7 @@ "$ref": "#/components/responses/401" }, "403": { - "$ref": "#/components/responses/403", - "description": "Forbidden. Returned when the access token lacks the `read` scope, when the requesting user is not allowed to read this screenshot, or when the account does not have the Attachable Screenshots feature." + "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" @@ -21587,10 +21587,6 @@ } }, "x-code-samples": [ - { - "lang": "Curl", - "source": "curl \"https://api.phrase.com/v2/projects/:project_id/screenshots/:id?branch=my-feature-branch\" \\\n -u USERNAME_OR_ACCESS_TOKEN" - }, { "lang": "CLI v2", "source": "phrase screenshots show \\\n--project_id \\\n--id \\\n--branch my-feature-branch \\\n--access_token " diff --git a/paths/screenshots/show.yaml b/paths/screenshots/show.yaml index ad73d271..fd6058d3 100644 --- a/paths/screenshots/show.yaml +++ b/paths/screenshots/show.yaml @@ -1,6 +1,9 @@ --- summary: Get a single screenshot -description: Get details on a single screenshot for a given project. +description: | + Returns a single screenshot belonging to the specified project. Use this to retrieve the screenshot's name, description, hosted image URL, and marker count after uploading, or before creating, updating, or inspecting its markers. The response is a synchronous, idempotent read — repeated calls return the same record without side effects. + + The Attachable Screenshots feature must be enabled on the account. operationId: screenshot/show tags: - Screenshots @@ -12,6 +15,7 @@ parameters: example: my-feature-branch name: branch in: query + required: false schema: type: string responses: @@ -30,20 +34,15 @@ responses: "$ref": "../../headers.yaml#/X-Rate-Limit-Reset" '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 `read` scope, when the requesting user is not allowed to read this screenshot, or when the account does not have the Attachable Screenshots feature. + '404': + "$ref": "../../responses.yaml#/404" '429': "$ref": "../../responses.yaml#/429" x-code-samples: -- lang: Curl - source: |- - curl "https://api.phrase.com/v2/projects/:project_id/screenshots/:id?branch=my-feature-branch" \ - -u USERNAME_OR_ACCESS_TOKEN - lang: CLI v2 source: |- phrase screenshots show \