use nullable on data types #56
Conversation
Prefer using `nullable: true` over `oneOf: [foo, null]` and `type: [foo, null]`. The `nullable: true` value should only be used if the property is contained in `required` so add the property to that where applicable.
There was a problem hiding this comment.
Here's the spec on what nullable is and where it should be used https://swagger.io/docs/specification/v3_0/data-models/data-types/#null
Just had a couple questions about correctness within the actual output of the API.
| $ref: "#/components/schemas/PaintOverride" | ||
| nullable: true |
There was a problem hiding this comment.
Is the value associated with a key in fillOverrideTable ever null? Seems like you just wouldn't have the key in the object.
| type: string | ||
| nullable: true |
There was a problem hiding this comment.
Added this here but it shouldn't be needed since the field isn't in required.
Wondering if BaseTypeStyle does have some required fields that aren't noted in this definition.
| type: string | ||
| nullable: true |
There was a problem hiding this comment.
Same as ☝️ in fillOverrideTable where its not clear if the images object will ever have a value where object.value == null.
There was a problem hiding this comment.
Holding this PR to give it a bit more review -- thank you for your patience so far @donny-dont 🙏🏼
Prefer using
nullable: trueoveroneOf: [foo, null]andtype: [foo, null].The
nullable: truevalue should only be used if the property is contained inrequiredso add the property to that where applicable.