feat(API): improve get /projects/{project_id}/screenshots/{id} documentation#1168
Closed
Stephen Lumenta (sbl) wants to merge 3 commits into
Closed
feat(API): improve get /projects/{project_id}/screenshots/{id} documentation#1168Stephen Lumenta (sbl) wants to merge 3 commits into
Stephen Lumenta (sbl) wants to merge 3 commits into
Conversation
…ntation Addresses rubric dimensions: conceptual_clarity, error_documentation, example_quality, frontmatter_metadata, reference_completeness, schema_completeness, self_contained_examples, stable_identifiers, vocabulary_consistency. Adds a structured description with usage guidance, id-field semantics, branch and access-control notes, and an error-code table. Replaces placeholder path examples with realistic ids and adds expected-response comments. Fixes operationId from screenshot/show to screenshots/show. Enriches error response descriptions with specific causes and remediations. Part of DEVEX-115.
Adds inline 200 example, expands 403 error table with per-cause remediation, sharpens all error response descriptions, and updates conceptual description to reference feature requirement and branch behaviour explicitly. Dimensions addressed: conceptual_clarity, error_documentation, example_quality, reference_completeness, schema_completeness, self_contained_examples, stable_identifiers. Jira: DEVEX-115
Stephen Lumenta (sbl)
added
the
developer-hub-api-quality
…piled.json Renaming an operationId changes generated client method and model names in every SDK, which is a breaking change; the repo convention is singular resource names for single-resource operations (plural only for /list). The compare-output CI job requires the regenerated bundle to ship with the spec change. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
jablan
reviewed
Jun 12, 2026
|
|
||
| Use this endpoint when you have a screenshot's `id` (its string code) and need its current | ||
| metadata or image URL. To discover screenshot codes, first call the list endpoint | ||
| (`screenshots/list`); to inspect the individual markers attached to a screenshot, call the |
Collaborator
There was a problem hiding this comment.
it should be possible to hyperlink other endpoints
jablan
reviewed
Jun 12, 2026
| (`screenshots/list`); to inspect the individual markers attached to a screenshot, call the | ||
| screenshot markers list endpoint. | ||
|
|
||
| **Feature requirement:** All screenshot endpoints require the Attachable Screenshots feature |
Collaborator
There was a problem hiding this comment.
internal implementation detail and shouldn't be exposed
jablan
reviewed
Jun 12, 2026
| **Access control:** The access token must carry the `read` OAuth scope. The authenticated | ||
| user must have at least read permission on the project and on the screenshot resource. | ||
|
|
||
| **The `id` field is a string code, not a numeric primary key.** The value returned in the |
Collaborator
There was a problem hiding this comment.
no need to be described in the description, individual request fields are described in the parameters section below.
same goes for branch parameter below. if the parameter needs to be elaborated, that should be done in the corresponding parameter description in the parameters section below.
jablan
reviewed
Jun 12, 2026
| codes for the project. | ||
| '429': | ||
| "$ref": "../../responses.yaml#/429" | ||
| description: >- |
Collaborator
There was a problem hiding this comment.
this description should be moved to 429 section in responses.yaml as it is identical for all requests.
Contributor
Author
|
Closing to re-run with updated fix-engine prompts (rules added for param-in-description and YAML section reordering). Fresh PRs incoming. |
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.
Jira: DEVEX-115