feat(API): improve get /projects/{project_id}/screenshots documentation#1169
Open
Stephen Lumenta (sbl) wants to merge 2 commits into
Open
feat(API): improve get /projects/{project_id}/screenshots documentation#1169Stephen Lumenta (sbl) wants to merge 2 commits into
Stephen Lumenta (sbl) wants to merge 2 commits into
Conversation
Sharpen conceptual clarity with a full description explaining screenshot purpose, branch isolation, pagination, and result ordering. Add richer parameter documentation for key_id. Add per-status error descriptions covering 400/401/403/404/429. Add a concrete JSON response example with two screenshots. Add a second Curl code sample showing key_id filtering. Swap inline branch param for the shared $ref. Addresses DEVEX-115.
Stephen Lumenta (sbl)
added
the
developer-hub-api-quality
The compare-output CI job diffs the committed bundle against a fresh swagger-cli compile, so spec changes must ship the regenerated bundle. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
jablan
reviewed
Jun 12, 2026
| parameters: | ||
| - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP" | ||
| - "$ref": "../../parameters.yaml#/project_id" | ||
| - "$ref": "../../parameters.yaml#/branch" |
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
2 participants
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: 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.
Closes DEVEX-115.