docs(API): improve get /projects/{project_id}/screenshots/{id} documentation#1189
Merged
Stephen Lumenta (sbl) merged 7 commits intoJul 1, 2026
Merged
Conversation
Stephen Lumenta (sbl)
added
the
developer-hub-api-quality
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 |
Stephen Lumenta (sbl)
changed the title
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>
Stephen Lumenta (sbl)
changed the title
Review feedback: error response descriptions should stay in the shared responses.yaml for consistency, not be re-authored inline per operation. Under OpenAPI 3.0 a description sibling of $ref is ignored anyway, so the inline text never rendered. Strip the inline $ref-sibling response descriptions (now bare $refs); the shared response owns the wording. Genuinely custom (non-$ref) response bodies are left intact. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Strings convention: never hand-author Curl or CLI v2 samples. Mintlify renders the request sample (curl + the multi-language playground) and the response from the OpenAPI operation itself, so a hand-written x-code-samples block drifts and overrides the correct auto-generated one; a CLI v2 sample is not spec-derivable at all. Remove the block so Mintlify renders. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
New strings rubric rule: Mintlify auto-generates the request curl, so a hand-written Curl sample is redundant and overrides it, but a CLI v2 sample cannot be derived from the spec and must be preserved. This PR originally removed the whole x-code-samples block; restore the CLI v2 entry (Curl stays dropped). compiled.json regenerated via make bundle.
jablan
reviewed
Jul 1, 2026
| example: my-feature-branch | ||
| name: branch | ||
| in: query | ||
| required: false |
Collaborator
There was a problem hiding this comment.
branch parameter should be available in parameters.yaml to be used as a reference. we should double check if all current usages are non-required (most should be), and then add this flag there as well. perhaps as a separate PR
jablan
approved these changes
Jul 1, 2026
Stephen Lumenta (sbl)
deleted the
devex-115-screenshots-get-a-single-screenshot
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/{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