[OpenAPI] case class field being an Option of an ADT are not rendered as nullable #3053
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
guizmaii
commented
Aug 26, 2024
| @@ -988,7 +988,7 @@ object OpenAPIGen { | |||
| } | |||
| private def schemaReferencePath(nominal: TypeId.Nominal, referenceType: SchemaStyle): String = { | |||
| referenceType match { | |||
| case SchemaStyle.Compact => s"#/components/schemas/${nominal.typeName}}" | |||
There was a problem hiding this comment.
Nasty typo, which was sadly validated by the tests here https://github.com/zio/zio-http/pull/3053/files#diff-0b5e5bc79ca85db4957d0ab782e9509a15f69b70d84ffd76a15a712367a860f3L2234-L2236
guizmaii
force-pushed
the
openapi_nullable_ref
branch
from
036f03f
to
d7e6375
Compare
guizmaii
force-pushed
the
openapi_nullable_ref
branch
from
d7e6375
to
751bd12
Compare
guizmaii
commented
Aug 26, 2024
Comment on lines
+3064
to
+3069
| | "optionalAdtField" : { | ||
| | "anyOf": [ | ||
| | { "type": "null" }, | ||
| | { "$ref": "#/components/schemas/SealedTraitCustomDiscriminator" } | ||
| | ] | ||
| | } |
There was a problem hiding this comment.
We now correctly have the anyOf
There was a problem hiding this comment.
I wonder, if this should be anyOf, or if the field should just be missing from the required fields list. I'd tend to the second. Most Scala json serialization does not write the field if the option is None
There was a problem hiding this comment.
Maybe both. To be accept all possible encodings
There was a problem hiding this comment.
Done. They are now both nullable and non-required
guizmaii
force-pushed
the
openapi_nullable_ref
branch
from
1c8f636
to
a665740
Compare
jdegoes
approved these changes
Aug 27, 2024
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.
Fixes #3052