feat(API): improve patch /projects/{project_id}/screenshots/{id} documentation#1167
Open
Stephen Lumenta (sbl) wants to merge 5 commits into
Open
feat(API): improve patch /projects/{project_id}/screenshots/{id} documentation#1167Stephen Lumenta (sbl) wants to merge 5 commits into
Stephen Lumenta (sbl) wants to merge 5 commits into
Conversation
Stephen Lumenta (sbl)
added
the
developer-hub-api-quality
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 rename also broke client generation in CI. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…rt schema The untitled multipart/form-data inline schema broke client generation: the generator imports the operationId-derived model name while the titled application/json schema generates under its own name, leaving a missing symbol in the Java client. The update endpoint only meaningfully accepts JSON (screenshot_update_params permits name and description only), so the multipart block goes. branch moves back into the request body to match main and every sibling write endpoint; Rails merges query and body params, so the body shape is the compatible, convention-consistent one. filename stays removed: the controller does not permit it on update. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The compare-output CI job diffs the committed bundle against a fresh swagger-cli compile, so spec changes must ship the regenerated bundle. 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
patch /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.