openapi3: resolve refs in parameter examples#1086
Merged
fenollp merged 3 commits intogetkin:masterfrom Jul 30, 2025
Merged
Conversation
This commit fixes a bug where `$ref`s in parameter examples were not being resolved during the loading of an OpenAPI 3 document. This would cause a validation error when the document was validated. The fix ensures that all `ExampleRef`s are properly resolved in `resolveParameterRef`, `resolveHeaderRef`, and `resolveRequestBodyRef` in `openapi3/loader.go`. A new test case is added to verify that the fix is working correctly.
This commit improves the test coverage for the fix in the previous commit. It adds a new test case that covers all the places where `resolveExampleRef` is called, ensuring that the fix is working correctly in all cases. The new test, `TestResolveExampleRef`, replaces the previous, less comprehensive test, `TestRefinExample`.
This commit improves the test coverage for the fix in the previous commit. It adds new test cases that cover all the places where `resolveExampleRef` is called, ensuring that the fix is working correctly in all cases. The new test file `example_refs_test.go` contains individual tests for each scenario.
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.
This commit fixes a bug where
$refs in parameter examples were not being resolved during the loading of an OpenAPI 3 document. This would cause a validation error when the document was validated.The fix ensures that all
ExampleRefs are properly resolved inresolveParameterRef,resolveHeaderRef, andresolveRequestBodyRefinopenapi3/loader.go.A new test case is added to verify that the fix is working correctly.
This will fix: oasdiff/oasdiff#730