feat(API): improve GET /projects/{project_id}/screenshots/{id} documentation#1164
Closed
Stephen Lumenta (sbl) wants to merge 1 commit into
Closed
feat(API): improve GET /projects/{project_id}/screenshots/{id} documentation#1164Stephen Lumenta (sbl) wants to merge 1 commit into
Stephen Lumenta (sbl) wants to merge 1 commit 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.
Stephen Lumenta (sbl)
added
the
developer-hub-api-quality
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
1 participant
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.
Fixes rubric dimensions: conceptual_clarity, error_documentation, example_quality, frontmatter_metadata, reference_completeness, schema_completeness, self_contained_examples, stable_identifiers, vocabulary_consistency
Part of DEVEX-115
Source-grounded via Phrase-Engineering/strings-app. Candidate cleared the grade-gated fix loop (> 4).