-
Notifications
You must be signed in to change notification settings - Fork 10
fix: validate empty component names in schema $ref and use spec-compliant separator #106
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Conversation
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
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Contributor
📊 Test Coverage ReportCurrent Coverage: Coverage Change: 📈 +.1% (improved) Coverage by Package
📋 Detailed Coverage by Function (click to expand)
Generated by GitHub Actions |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
This PR fixes a validation gap where empty component names in schema
$refreferences were not being caught by validation. It also updates the bundler/joiner to use spec-compliant separators.Problem
Invalid references like
$ref: '#/components/schemas/'(empty component name) were not being validated becauseSchema.Validate()was not callingReference.Validate().Additionally, the bundler and joiner were using
~as a separator in component names (e.g.,external_api_yaml~User), but~is a special escape character in JSON pointers and invalid in component names per the OpenAPI spec (^[a-zA-Z0-9.\-_]+$).Changes
Validation Fix
jsonschema/oas3/validation.go: Added reference validation toSchema.Validate()to catch invalid references including empty component namesValidate[T]function (nil schema, bool schema, valid/invalid schema)$schemafield variationsBundler/Joiner Separator Fix
openapi/bundle.go,openapi/join.go: Changed component name separator from~to__(double underscore) which is spec-compliantTest Coverage Improvements
Validate[T](top-level)Schema.ValidateinitValidationVerification
mise cipasses