fix(API): improve patch /projects/{project_id}/screenshots/{id} documentation#1190
Open
Stephen Lumenta (sbl) wants to merge 3 commits into
Open
fix(API): improve patch /projects/{project_id}/screenshots/{id} documentation#1190Stephen Lumenta (sbl) wants to merge 3 commits into
Stephen Lumenta (sbl) wants to merge 3 commits into
Conversation
Contributor
API changelog (oasdiff)Doc-only edits (descriptions, examples) do not appear here. |
Apply the batch review conventions: - Move the per-status 'Errors:' prose and the scope/permission sentence out of the top-level description and onto the response objects. - Remove the non-standard 'response:' block from each code sample; samples now show only the request, and the 200 example documents the response. - CLI sample: use <project_id>/<id>/<token> placeholders instead of concrete slug-like values. - Normalize the branch property to 'specify the branch to use'. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
An empty 'required' array is invalid under the OpenAPI 3.0 meta-schema (it must have at least one entry), which was failing 'swagger-cli validate' in the lint gate. The endpoint has no required fields, so the key is simply removed. 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
patch /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