Allow resolving of external refs in openapi #70
Merged
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
added 2 commits
September 5, 2022 17:18
|
Im not sure why the Scrutinizer tests aren't passing. I have no issues when I run the tests locally |
|
Will this also support local references to a relative path? |
strider2038
reviewed
Sep 8, 2022
| @@ -9,7 +9,7 @@ type SpecificationLoader interface { | |||
| func New() SpecificationLoader { | |||
| return &processingLoader{ | |||
| &autoLoader{ | |||
| loader: openapi3.NewLoader(), | |||
| loader: &openapi3.Loader{IsExternalRefsAllowed: true}, | |||
There was a problem hiding this comment.
Hi! Thanks for the PR. Perhaps this behavior should be configurable. What do you think?
I suggest adding options.
For package loader.
type Options struct {
IsExternalRefsAllowed bool
}
func New(options Options) SpecificationLoader {
return &processingLoader{
&autoLoader{
loader: &openapi3.Loader{
IsExternalRefsAllowed: options.IsExternalRefsAllowed,
},
},
}
}YAML option
# OpenAPI specification options
openapi:
specification_url: 'path/to/your/openapi-specification.yaml'
allow_external_refs: trueIn config package
type Configuration struct {
// OpenAPI options
SpecificationURL string
AllowExternalRefs boolThere was a problem hiding this comment.
I agree. The PR in its current form is for a "PoC" if you like. I will add this and update the PR.
@strider2038 What to do about the failing tests in the CI. They pass locally on my machine. Can you confirm it's the same for you?
There was a problem hiding this comment.
I thought a little more. It seems that it is better to leave the behavior as simple as possible. If it is necessary for security reasons, it is better to add an option to disable reference reading.
What to do about the failing tests in the CI. They pass locally on my machine. Can you confirm it's the same for you?
It looks like these are some issues with scrutinizer in newer versions of Go.
@crjones |
|
@strider2038 Any idea when you will release this? |
|
@kylehodgetts released in v0.3.3 |
PixnBits
added a commit
to PixnBits/openapi-mock
that referenced
this pull request
Jun 27, 2024
support added in v0.3.3 via muonsoft#70
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.
Given an API whose response schema is hosted externally, i want to be able to mock this API without having to edit the openapi file to move the schema definitions inline.
Before the change, openapi-mock would throw an error about encountering a disallowed external reference. Now mock responses work as expected, returning mock responses that conform to the schema hosted at the given url.