docs(openapi): pin VersionInfo.viVersion length to match the validator (#308)#309
Merged
Merged
Conversation
versioninfo.schema.js caps `viVersion` at 1..255 chars, but the
OpenAPI component schema declared it as a bare `{ type: 'string' }`.
SDK generators reading the spec couldn't see the bound, so client-
side validation had no way to catch oversized payloads before they
round-trip.
SemVer is much shorter than 255 in practice, but the cap matches
every other free-text "name/identifier" column in the API for
consistency.
Add `minLength: 1, maxLength: 255` to the component schema and pin
the bound with a test in tests/api/openapi.test.js.
Co-Authored-By: Claude Opus 4.7 (1M context) <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.
Closes #308.
Summary
versioninfo.schema.js caps
viVersionat 1..255 chars. The OpenAPI component schema left it unbounded. AddsminLength: 1, maxLength: 255and pins it with a test.Test plan
npm run lint && npm test— 773 passing (was 772).Proudly Made in Nebraska. Go Big Red! 🌽 https://xkcd.com/2347/