docs(API): improve get /projects/{project_id}/screenshots/{id} documentation#1189
Open
Stephen Lumenta (sbl) wants to merge 2 commits into
Open
docs(API): improve get /projects/{project_id}/screenshots/{id} documentation#1189Stephen Lumenta (sbl) wants to merge 2 commits into
Stephen Lumenta (sbl) wants to merge 2 commits into
Conversation
Contributor
API changelog (oasdiff)Doc-only edits (descriptions, examples) do not appear here. |
Contributor
Author
|
This PR replaces #1168, which was closed after jablan's review. Feedback addressed from #1168:
What changed:
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 |
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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