Skip to content

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

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

feat(API): improve get /projects/{project_id}/screenshots/{id} documentation#1189
Stephen Lumenta (sbl) wants to merge 1 commit 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

Copy link
Copy Markdown
Contributor

API changelog (oasdiff)

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

No changes to report, but the specs are different.
Run 'oasdiff diff' to see structural differences.

@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

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