docs(API): improve delete /projects/{project_id}/screenshots/{id} documentation#1186
Open
Stephen Lumenta (sbl) wants to merge 3 commits into
Open
docs(API): improve delete /projects/{project_id}/screenshots/{id} documentation#1186Stephen Lumenta (sbl) wants to merge 3 commits into
Stephen Lumenta (sbl) wants to merge 3 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
…s/{id}
- Remove the per-status 'Errors:' enumeration from the top-level
description; each status code already carries its own description on
the response object (theSoenke).
- Drop the 'HTTP/1.1 204 No Content' response line from the curl sample
so it shows only the request, like every other endpoint.
- Remove the endpoint-level security block. No other endpoint declares
one; global security (Token/Basic) already applies, and the block was
silently swapping Basic for OAuth2 on just this operation.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Stephen Lumenta (sbl)
changed the title
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
delete /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