Ensure embedded spec contains all necessary OpenAPI documents #771
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
jamietanna
force-pushed
the
defect/embedded-spec
branch
from
b765380
to
36387aa
Compare
jamietanna
force-pushed
the
defect/embedded-spec
branch
from
36387aa
to
350fdda
Compare
When using a schema that uses `$ref`s to an external file, although we generate the mappings appropriately, this then leads to the embedded spec being misaligned, as it continues to use the `$ref` to that external file, which then is not available when calling i.e. `GetSwagger`. We can take advantage of the `InternalizeRefs` method to perform an in-place modification to apply those external references into a single, embeddable spec. This appears to only work when a full file is referenced, instead of a path within a file.
jamietanna
force-pushed
the
defect/embedded-spec
branch
from
350fdda
to
8a93137
Compare
adrianpk
pushed a commit
to foorester/oapi-codegen
that referenced
this pull request
Jan 16, 2024
Ensure embedded spec contains all necessary OpenAPI documents
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.
When using a schema that uses
$refs to an external file, although wegenerate the mappings appropriately, this then leads to the embedded
spec being misaligned, as it continues to use the
$refto thatexternal file, which then is not available when calling i.e.
GetSwagger.We can take advantage of the
InternalizeRefsmethod to perform anin-place modification to apply those external references into a single,
embeddable spec.