OpenAPI Spec fix nullable alongside $ref#32887
Merged
pierrejeambrun merged 4 commits intoAug 2, 2023
Merged
Conversation
pierrejeambrun
requested review from
ashb,
bbovenzi,
ephraimbuddy and
ryanahamilton
as code owners
July 27, 2023 16:29
ferruzzi
reviewed
Jul 27, 2023
Member
Author
|
More work is required, this is breaking some tests. Converting to draft. |
uranusjr
previously approved these changes
Jul 28, 2023
uranusjr
dismissed
their stale review
July 28, 2023 06:00
Hmm the errors seem more serious than I thought
uranusjr
marked this pull request as draft
July 28, 2023 06:00
pierrejeambrun
force-pushed
the
fix-nullable-ref-open-api-spec
branch
from
July 31, 2023 23:02
adabae4 to
af067fa
Compare
pierrejeambrun
marked this pull request as ready for review
July 31, 2023 23:03
Member
Author
|
CI should be green now. The hard part is that both |
potiuk
approved these changes
Aug 1, 2023
uranusjr
reviewed
Aug 1, 2023
hussein-awala
approved these changes
Aug 2, 2023
ephraimbuddy
pushed a commit
that referenced
this pull request
Aug 3, 2023
* OpenAPI Spec fix nullable alongside $ref * Fix CI * Update following code review * Add deprecation warning for 'none' state. (cherry picked from commit 3141d4b)
This file contains hidden or 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
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.
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: