Remove "nullable" in OAS 3.1? #2244

Activity

1. handrews

   added

   schema-object

   on May 27, 2020
2. darrelmiller commented on May 28, 2020

   

   darrelmiller

   on May 28, 2020

   Member

   More actions

   Now that we allow the Schema Object to allow any unknown property (to enable vocabularies) an instance of a nullable property would not fail validation rules for a 3.1 description. Be warned thought, tooling might not work as expected because the nullable keyword might not be respected.
3. darrelmiller

   closed this as completedon May 28, 2020
4. rwalle61 commented on Aug 15, 2021

   

   rwalle61

   on Aug 15, 2021

   Last edited by rwalle61

   More actions

   Thanks for this and #2246!

   To confirm, how should an openapi doc describe an object with a property 'foo' that can be string or null - just like this?

   type: object
   properties:
     foo:
       type: string

   I couldn't find this described anywhere, and OpenAPI 3.1.0 barely mentions null.

   Out of interest, is there any summary of why null has been removed since OpenAPI 3.0.3?

   And fyi you may want to update this proposal about nullable to clarify that it was rejected :)

   (I maintain an OpenAPI tool and a user has asked about using nullable)

   Thanks again 😄

   👍React with 👍3Reacted by Alex Rattray, Tyler Seader and Marco van 't Wout
5. handrews commented on Aug 15, 2021

   

   handrews

   on Aug 15, 2021

   MemberAuthor

   More actions

   @rwalle61 it's not much mentioned because it's covered by JSON Schema and OAS 3.1 tries to avoid duplicating the JSON Schema spec unless it is needed to explain how JSON Schema and OAS-specific concepts interact.

   What you are looking for is:

   type: object
   properties:
     foo:
       type: [string, "null"]

   That's the string "null", not the value null. The string "null" is the name of the type of the value null. The values in the type array can be in any order.

   👍React with 👍3Reacted by Alex Rattray, Daniel Abernathy and Oleg Lustenko

   👀React with 👀1Reacted by Artem Boiarshinov
6. handrews commented on Aug 15, 2021

   

   handrews

   on Aug 15, 2021

   MemberAuthor

   More actions

   @rwalle61 also, that nullable proposal was for 3.0, and was accepted for 3.0.3. Subsequently, nullable was removed from 3.1.0.
7. rwalle61 commented on Aug 22, 2021

   

   rwalle61

   on Aug 22, 2021

   More actions

   @handrews perfect, thanks for clarifying!