Add the required response description to the usage OpenAPI specs - #445
Merged
Conversation
GitBook reported "oneOf must match exactly one schema in oneOf" on the 200 of both usage specs. OpenAPI 3.0 requires `description` on a Response Object, so without it the object matches neither Response nor Reference and the union fails. Rendering already worked — the billing specs carry ten processing errors of their own and render fine — but the specs should be valid. Co-Authored-By: Claude Opus 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
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.
Summary
After registering
usage-v2andusage-detail-v2in GitBook, both came backprocessingState=completebut with one validation error each:OpenAPI 3.0 requires
descriptionon a Response Object. Without it the object matches neitherResponsenorReference, so the union fails. Adds it to the 200 of both specs.Impact
Cosmetic — the pages already render. For comparison,
billing-v2andbilling-detail-v2each carry ten processing errors (from their placeholderrequestBodywith"type": "–") and render fine. Mine had one. Still worth fixing rather than leaving a knowingly invalid spec.After this merges, re-
PUTboth slugs through the GitBook API so it refetches frommain.