feat(API): improve GET /projects/{project_id}/screenshots/{id} documentation#1159
Closed
Stephen Lumenta (sbl) wants to merge 1 commit into
Closed
feat(API): improve GET /projects/{project_id}/screenshots/{id} documentation#1159Stephen Lumenta (sbl) wants to merge 1 commit into
Stephen Lumenta (sbl) wants to merge 1 commit into
Conversation
…ntation Fix rubric dimensions: conceptual_clarity, error_documentation, example_quality, frontmatter_metadata, reference_completeness, schema_completeness, self_contained_examples, stable_identifiers, vocabulary_consistency. - operationId corrected to screenshots/show (was screenshot/show) - branch parameter uses shared $ref instead of inline duplicate - description expanded with what/why/access-control/branch semantics - 403 response lists all three distinct paths to forbidden - response example added with realistic values derived from serializer - curl example uses full URL with realistic project_id + screenshot id - schema properties gain descriptions and per-field examples Part of DEVEX-60. Source-grounded via Phrase-Engineering/strings-app.
Stephen Lumenta (sbl)
deleted the
en-api-strings-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
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-60
Source-grounded via Phrase-Engineering/strings-app.
Changes
paths/screenshots/show.yamloperationIdcorrected fromscreenshot/showtoscreenshots/show(stable_identifiers, vocabulary_consistency)branchparameter converted from inline definition to$ref: ../../parameters.yaml#/branch(reference_completeness)descriptionexpanded: states what the endpoint does, when to use it, explains theidfield is a string code, documents access control (read scope + grant_read permission + Attachable Screenshots feature gate), and branch semantics (conceptual_clarity)403response gains a description listing all three distinct paths to forbidden: missing read scope, insufficient user permission, and feature not on plan (error_documentation)200response gains an inlineexamplewith realistic values derived from the serializer (example_quality, self_contained_examples)schemas/screenshot.yamldescriptionand anexamplevalue (schema_completeness)exampleupdated to use consistent realistic values matching the path-level example