fix(API): improve post /projects/{project_id}/screenshots documentation#1182
Open
Stephen Lumenta (sbl) wants to merge 2 commits into
Open
fix(API): improve post /projects/{project_id}/screenshots documentation#1182Stephen Lumenta (sbl) wants to merge 2 commits into
Stephen Lumenta (sbl) wants to merge 2 commits into
Conversation
Stephen Lumenta (sbl)
added
the
developer-hub-api-quality
Contributor
API changelog (oasdiff)Doc-only edits (descriptions, examples) do not appear here. |
Stephen Lumenta (sbl)
changed the title
Stephen Lumenta (sbl)
added a commit
that referenced
this pull request
Jun 17, 2026
…ent_id}/keys - Move the per-status prose out of the top-level description and onto the response objects (the pattern from #1182), removing the 'Errors:' block and the inline 'Returns 422 ...' sentence. (theSoenke) - Normalize the branch parameter (query + body) to 'specify the branch to use', matching the wording used across the rest of the API rather than a bespoke 'When omitted, the main (default) branch is used.' (theSoenke) - Fix the CLI v2 command: 'phrase figma_attachments create', not the non-existent 'phrase figma_attachment attach_to_key'. (theSoenke) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
- Drop the 'Requires the write scope and manage permission ...' sentence from the description; the 403 response already documents the write-scope and manage-permission requirement, and no other endpoint documents scopes in prose. (theSoenke) - Normalize the branch property to 'specify the branch to use', dropping the unclear 'instead of the project default' wording, for consistency with the rest of the API. (theSoenke) 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
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
post /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
🤖 Generated with Claude Code