-
Notifications
You must be signed in to change notification settings - Fork 10
feat: add reference chain tracking API for nested schema references #119
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❌ Patch coverage is
📢 Thoughts on this report? Let us know! |
Contributor
📊 Test Coverage ReportCurrent Coverage: Coverage Change: ✅ No change 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
Labels
enhancement
New feature or request
jsonschema
Related to JSON Schema handling
tests
Test-related changes and improvements
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
Adds a new API for tracking reference resolution chains in JSON Schema, enabling callers to understand how nested
$refreferences were resolved and which schemas share common references.Problem
When working with OpenAPI specifications containing nested schema references, there's often a need to:
Solution
Introduces three new methods on
JSONSchema:GetReferenceChain()- Returns the full chain of references from outermost (top-level parent) to innermost (immediate parent)GetImmediateReference()- Returns just the immediate parent reference that resolved to this schemaGetTopLevelReference()- Returns the outermost reference that started the resolution chainEach method returns
ReferenceChainEntrycontaining both the referencing schema and its$refvalue.Example
For a response schema referencing
Schema1, which in turn referencesSchemaShared:Calling
GetReferenceChain()on the resolvedSchemaSharedreturns:"#/components/schemas/Schema1""#/components/schemas/SchemaShared"Changes
jsonschema/oas3/resolution.go- AddedReferenceChainEntrytype and three new methodsopenapi/nested_reference_tracking_test.go- Comprehensive tests covering various reference chain scenariosTesting
All existing tests pass. Added 395 lines of new test coverage for the reference chain tracking feature.