-
Notifications
You must be signed in to change notification settings - Fork 14.6k
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
OpenAPI Spec fix nullable alongside $ref #32887
OpenAPI Spec fix nullable alongside $ref #32887
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is my first time looking at OpenAPI, but the changes all appear logical to me. Call this a non-binding +1 :P
More work is required, this is breaking some tests. Converting to draft. |
Hmm the errors seem more serious than I thought
adabae4
to
af067fa
Compare
CI should be green now. The hard part is that both |
* OpenAPI Spec fix nullable alongside $ref * Fix CI * Update following code review * Add deprecation warning for 'none' state. (cherry picked from commit 3141d4b)
Fix wrong usage of nullable prop next to a ref. TLDR $ref shouldn’t have sibling. (unless OpenAPI 3.1 that allows description and summary only I believe).
This induce wrong api documentation and most importantly bugs in our python clients such as:
This allows to generate the expected api doc and the correct client.
I Tried that locally by regenerating the client and making the problematic call, such as:
It is working with this spec.
After this we can: