fix: Centralize OpenAPI schema reference resolution #40
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.
Why:
Centralizes the OpenAPI schema reference resolution -> more simple and maintainable. Spec has references resolved at creation preventing subtle bugs (i.e parameters of an operationId not resolved properly).
What:
jsonref
loading and replacement within theOpenAPISpecification
class constructor, ensuring all references are resolved upon object instantiation.How can it be used:
How did you test it:
Notes for the reviewer:
OpenAPISpecification
class constructor where instance variablespec_dict
is by default reference resolvedjsonref_import.check()
calls in converter functions could have any unintended side effects, although initial tests suggest the refactoring maintains the desired outcomes.