Skip to content

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

Open
Stephen Lumenta (sbl) wants to merge 2 commits into
mainfrom
devex-115-screenshots-get-a-single-screenshot
Open

docs(API): improve get /projects/{project_id}/screenshots/{id} documentation#1189
Stephen Lumenta (sbl) wants to merge 2 commits into
mainfrom
devex-115-screenshots-get-a-single-screenshot

Conversation

@sbl

Copy link
Copy Markdown
Contributor

Improves the documentation for get /projects/{project_id}/screenshots/{id}: sharper descriptions, parameter docs, error responses, and usage examples.

Drafted with AI assistance and grounded in the API implementation. Please review for technical accuracy before merging; nothing is merged automatically.

🤖 Generated with Claude Code

@sbl Stephen Lumenta (sbl) added the developer-hub-api-quality API doc quality fix from the API Grader label Jun 15, 2026
@github-actions

github-actions Bot commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

API changelog (oasdiff)

Doc-only edits (descriptions, examples) do not appear here.

10 changes: 0 error, 0 warning, 10 info
info	[response-property-became-required] at doc/compiled.json
	in API GET /formats
		the response property `items/api_name` became required for the status `200`

info	[response-property-became-required] at doc/compiled.json
	in API GET /formats
		the response property `items/default_encoding` became required for the status `200`

info	[response-property-became-required] at doc/compiled.json
	in API GET /formats
		the response property `items/default_file` became required for the status `200`

info	[response-property-became-required] at doc/compiled.json
	in API GET /formats
		the response property `items/description` became required for the status `200`

info	[response-property-became-required] at doc/compiled.json
	in API GET /formats
		the response property `items/exportable` became required for the status `200`

info	[response-property-became-required] at doc/compiled.json
	in API GET /formats
		the response property `items/extension` became required for the status `200`

info	[response-property-became-required] at doc/compiled.json
	in API GET /formats
		the response property `items/importable` became required for the status `200`

info	[response-property-became-required] at doc/compiled.json
	in API GET /formats
		the response property `items/includes_locale_information` became required for the status `200`

info	[response-property-became-required] at doc/compiled.json
	in API GET /formats
		the response property `items/name` became required for the status `200`

info	[response-property-became-required] at doc/compiled.json
	in API GET /formats
		the response property `items/renders_default_locale` became required for the status `200`

@sbl

Copy link
Copy Markdown
Contributor Author

This PR replaces #1168, which was closed after jablan's review.

Feedback addressed from #1168:

Comment Status
"Internal implementation detail and shouldn't be exposed" ✅ Fixed
"No need to describe id/branch in the description — that belongs in parameters" ✅ Fixed
"429 description is identical for all requests — move to responses.yaml" ✅ Fixed
"It should be possible to hyperlink other endpoints" ⚠️ Not addressed — see note below

What changed:

  • branch elaboration is moved to the parameter's own description field in parameters:. The top-level description no longer restates individual request fields.
  • Internal detail removed from the description body.
  • 429 now uses a bare $ref: "../../responses.yaml#/429" with no inline description override.

Open item — hyperlinks: Related endpoints are referenced in plain prose rather than as Markdown links. If clickable cross-references are a hard requirement, let us know and we'll update the description accordingly.

🤖 Generated with Claude Code

@sbl Stephen Lumenta (sbl) changed the title feat(API): improve get /projects/{project_id}/screenshots/{id} documentation fix(API): improve get /projects/{project_id}/screenshots/{id} documentation Jun 17, 2026
Apply the batch review conventions:
- Move the 'Error reference' table out of the top-level description and
  onto the response objects (400/401/403/404/429 carry their own
  description); keep only purpose and the feature-availability note.
- Normalize the branch parameter to 'specify the branch to use'.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@sbl Stephen Lumenta (sbl) changed the title fix(API): improve get /projects/{project_id}/screenshots/{id} documentation docs(API): improve get /projects/{project_id}/screenshots/{id} documentation Jun 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

developer-hub-api-quality API doc quality fix from the API Grader

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant