-
Notifications
You must be signed in to change notification settings - Fork 154
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
References are not resolved according to RFC3986 #272
Comments
hi @hiddewie! Thanks for creating the issue. I did a quick investigation and this is the outcome:
There are 2 possible solutions I see so far:
Do you know who I can ping here in order to receive an opinion which direction we prefer to go? Maybe @joschi you could let us know what's your opinion? Thx in advance. Referring the property of the schema object.I didn't found any restrictions to use such way (
|
Hi @timur27. Thanks for the reaction. I know that this is not the best way to refer to properties. However, our users are free to use any valid OpenAPI structure in their documents. Unfortunately that also means that our users can use uncommon ways to make It would be good if openapi-diff should not implement a solution specific to this problem, but rather create a solution that supports any valid value of |
Additional to the use case of @hiddewie, an RFC3986 compliant ref resolving would also support an OpenAPI-Spec that is splitted in multiple (possibly remote) files. |
See the specification here: https://swagger.io/docs/specification/using-ref/.
This points to RFC3986 (https://tools.ietf.org/html/rfc3986) for the structure of JSON references. This RFC is not supported in openapi-diff.
I made an example of a valid reference according to OpenAPI 3, for which OpenAPI diff throws an error. See #271
Example content:
The text was updated successfully, but these errors were encountered: