Skip to content

docs(API): improve get /projects/{project_id}/screenshots/{id} documentation #1189

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.

Sign up for GitHub

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

Merged
Stephen Lumenta (sbl) merged 7 commits into from
Jul 1, 2026
Merged

docs(API): improve get /projects/{project_id}/screenshots/{id} documentation #1189

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
43917b4
feat(API): improve get /projects/{project_id}/screenshots/{id} docume…
sbl Jun 15, 2026
a738307
docs(API): clean up get /projects/{project_id}/screenshots/{id}
sbl Jun 17, 2026
8b1f377
docs(API): move error-response prose to shared responses.yaml
sbl Jun 24, 2026
b5da146
docs(API): remove hand-written x-code-samples
sbl Jun 24, 2026
7f8336e
Merge branch 'main' into devex-115-screenshots-get-a-single-screenshot
sbl Jun 24, 2026
fa10da0
Merge branch 'main' into devex-115-screenshots-get-a-single-screenshot
sbl Jun 25, 2026
cf58285
fix(API): keep CLI v2 code sample, only drop hand-written Curl
sbl Jun 29, 2026
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
10 changes: 3 additions & 7 deletions doc/compiled.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -21542,6 +21542,7 @@
"example": "my-feature-branch",
"name": "branch",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
Expand Down Expand Up @@ -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"
Expand All @@ -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 <project_id> \\\n--id <id> \\\n--branch my-feature-branch \\\n--access_token <token>"
Expand Down
15 changes: 7 additions & 8 deletions paths/screenshots/show.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -12,6 +15,7 @@ parameters:
example: my-feature-branch
name: branch
in: query
required: false

@jablan jablan Jul 1, 2026

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.

branch parameter should be available in parameters.yaml to be used as a reference. we should double check if all current usages are non-required (most should be), and then add this flag there as well. perhaps as a separate PR

schema:
type: string
responses:
Expand All @@ -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 \
Expand Down
Loading