Fix: Allow consumers to specify how many circular references are allowed #1204
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/circular
branch
from
b54713c
to
0a9de92
Compare
As noted in #936, we have an issue where a number of circular references may be expected and allowed, so we should provide the ability to configure this, allowing users to decide what makes sense for them. This requires we add an additional method, `LoadSwaggerWithCircularReferenceCount`, as the existing method is part of our public API and we cannot modify it without breaking consumers. This is already available in the version of kin-openapi we're using, we're just configuring it. Closes #936, #957.
jamietanna
force-pushed
the
defect/circular
branch
from
0a9de92
to
fe07af0
Compare
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.
As noted in #936, we have an issue where a number of circular references
may be expected and allowed, so we should provide the ability to
configure this, allowing users to decide what makes sense for them.
This requires we add an additional method,
LoadSwaggerWithCircularReferenceCount, as the existing method is partof our public API and we cannot modify it without breaking consumers.
This is already available in the version of kin-openapi we're using,
we're just configuring it.
Closes #936, #957.