feat(API): improve post /projects/{project_id}/screenshots documentation#1171
Open
Stephen Lumenta (sbl) wants to merge 3 commits into
Open
feat(API): improve post /projects/{project_id}/screenshots documentation#1171Stephen Lumenta (sbl) wants to merge 3 commits into
Stephen Lumenta (sbl) wants to merge 3 commits into
Conversation
Addresses rubric dimensions: conceptual_clarity, error_documentation, example_quality, frontmatter_metadata, reference_completeness, schema_completeness, self_contained_examples, stable_identifiers. - Expands description with workflow context, file upload requirements, side effects, access control matrix, and branch guidance - Fixes operationId to screenshots/create (was screenshot/create) - Adds required: [filename] constraint to request body schema - Adds realistic inline example on 201 response - Expands 403 description to enumerate all distinct forbidden cases - Improves all property descriptions with actionable language - Replaces placeholder :project_id curl URL with a concrete example ID - Removes non-standard filename binary example value Part of DEVEX-115
…ields for POST screenshots Adds per-status-code descriptions for 400, 401, 404, 422, 429; adds `name` to the required fields list; enriches the description field with accepted formats, name uniqueness, and file upload constraints. Addresses DEVEX-115 dimensions: error_documentation, schema_completeness, reference_completeness, example_quality, self_contained_examples.
Stephen Lumenta (sbl)
added
the
developer-hub-api-quality
…elds, regenerate bundle 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). name drops out of the required list: the model derives a name from the uploaded file's name on create (before_validation :derive_name_from_filename), so only filename is genuinely required. The name property description documents the derivation. The compare-output CI job requires the regenerated doc/compiled.json bundle to ship with the spec change. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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.
Improves the documentation for
post /projects/{project_id}/screenshots: 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.