Normalize relative ref paths to avoid duplicating schemas #2105
Conversation
This file contains 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
Currently, if an OpenAPI spec contains multiple relative refs to the same file, but those refs are located in different files and use different relative paths to reach the one file, swagger-parser will create a separate, duplicate schema for each relative path rather than reusing the same schema across all equivalent paths. For example, given a spec with the following refs: - In spec root directory, `$ref: ./components/schemas/Thing.yaml` - In components/paths subdirectory, `$ref: ../../components/schemas/Thing.yaml` The parser will produce a `Thing` and a `Thing_1` schema object instead of reusing `Thing` for the second, equivalent reference. This updates the ref processor to resolve relative paths before processing relative refs in order to produce a single `Thing` schema that is reused for all equivalent references.
ctreatma
force-pushed
the
collapse-equivalent-refs
branch
from
6f1d634
to
18d5450
Compare
ctreatma
commented
Jun 17, 2024
| @@ -0,0 +1,12 @@ | |||
| description: |- | |||
There was a problem hiding this comment.
In a pinch, I added the entire impacted spec as a test resource, but I need to trim it down to just the parts necessary for the new test.
6 tasks
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.
Currently, if an OpenAPI spec contains multiple relative refs to the same file, but those refs are located in different files and use different relative paths to reach the one file, swagger-parser will create a separate, duplicate schema for each relative path rather than reusing the same schema across all equivalent paths.
For example, given a spec with the following refs:
$ref: ./components/schemas/Thing.yaml$ref: ../../components/schemas/Thing.yamlThe parser will produce a
Thingand aThing_1schema object instead of reusingThingfor the second, equivalent reference.This updates the ref processor to resolve relative paths before processing relative refs in order to produce a single
Thingschema that is reused for all equivalent references.