fix: bundle original spec to account for multi-file API definitions #252
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
barrett-schonefeld
approved these changes
Feb 25, 2021
dpopp07
force-pushed
the
dp/multi-file-fix
branch
from
b6d6060
to
cf8983c
Compare
We do some validations on the "resolved spec" or the full API definition with all of its references resolved into one large document. This takes multi-file specs into account and resolves all references, even to other files. However, some validations are performed only on the original spec as it provides some benefits, such as gathering all schemas without worrying about duplicates. The problem with our current approach is that, if the spec is split into multiple files, we only validate the entry file and none of the others. This adds a quick step to "bundle" all of the files together into one "file" that only has internal references. This way, the unresolved "js spec" will represent the entire definition.
dpopp07
force-pushed
the
dp/multi-file-fix
branch
from
cf8983c
to
64ff8de
Compare
dpopp07
pushed a commit
that referenced
this pull request
Mar 9, 2021
## [0.35.2](v0.35.1...v0.35.2) (2021-03-09) ### Bug Fixes * bundle original spec to account for multi-file API definitions ([#252](#252)) ([f241c8b](f241c8b))
|
🎉 This PR is included in version 0.35.2 🎉 The release is available on: Your semantic-release bot 📦🚀 |
This was referenced Mar 10, 2021
This was referenced Mar 17, 2021
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.
We do some validations on the "resolved spec" or the full API definition with all of its
references resolved into one large document. This takes multi-file specs into account and
resolves all references, even to other files. However, some validations are performed only
on the original spec as it provides some benefits, such as gathering all schemas without
worrying about duplicates. The problem with our current approach is that, if the spec is
split into multiple files, we only validate the entry file and none of the others.
This adds a quick step to "bundle" all of the files together into one "file" that only has
internal references. This way, the unresolved "js spec" will represent the entire definition.
Resolves #229