Added issue OAI#2057 - interactions between nullable and default value.

RepreZen · Nov 17, 2019 · 8b766fe · 8b766fe
1 parent e456a98
commit 8b766fe
Showing 1 changed file with 10 additions and 2 deletions.
diff --git a/proposals/003_Clarify-Nullable.md b/proposals/003_Clarify-Nullable.md
@@ -10,7 +10,7 @@
 |Review Manager |TBD|
 |Status |Proposal|
 |Implementations |N/A|
-|Issues | [1900](https://github.com/OAI/OpenAPI-Specification/issues/1900), [1368](https://github.com/OAI/OpenAPI-Specification/issues/1368), [1389](https://github.com/OAI/OpenAPI-Specification/issues/1389), [1957](https://github.com/OAI/OpenAPI-Specification/pull/1957), [2046](https://github.com/OAI/OpenAPI-Specification/pull/2046), [1977](https://github.com/OAI/OpenAPI-Specification/pull/1977#issuecomment-533333957) |
+|Issues | [1900](https://github.com/OAI/OpenAPI-Specification/issues/1900), [1368](https://github.com/OAI/OpenAPI-Specification/issues/1368), [1389](https://github.com/OAI/OpenAPI-Specification/issues/1389), [1957](https://github.com/OAI/OpenAPI-Specification/pull/1957), [2046](https://github.com/OAI/OpenAPI-Specification/pull/2046), [1977](https://github.com/OAI/OpenAPI-Specification/pull/1977#issuecomment-533333957), [2057](https://github.com/OAI/OpenAPI-Specification/issues/2057)|
 |Previous Revisions |N/A |
 
 ## Change Log
@@ -87,7 +87,7 @@ components:
 
     UTCDate:
       allOf:
-        $ref: "#/components/schemas/OptionalDate"
+      - $ref: "#/components/schemas/OptionalDate"
       not:
         type: string
         pattern: "^.*Z.*$"
@@ -140,6 +140,8 @@ Questions that are not answered by the current specification include the followi
 
 * What is the correct translation of a nullable schema from OpenAPI into an equivalent JSON Schema?
 
+* Is `null` allowed as the `default` value of a nullable schema? (See [#2057](https://github.com/OAI/OpenAPI-Specification/issues/2057).)
+
 ## Proposed solution
 
 We propose to clarify the 3.0 specification in the next patch release, to resolve these questions and align OpenAPI's Schema Object with JSON Schema's well-defined, constraint-based semantics.
@@ -196,6 +198,12 @@ Yes. The subtype can specify a `type` without `nullable: true`, or can specify `
 
 A nullable type should translate into a type array with two string elements: the name of the type specified in the Schema Object, and `"null"`.
 
+####  Is `null` allowed as the `default` value of a nullable schema? (See [#2057](https://github.com/OAI/OpenAPI-Specification/issues/2057).)
+
+Yes. For example, a Schema Object with `"type" : "string", "nullable" : true` would translate to a JSON Schema with `"type" : ["string", "null"]`. That schema permits `"default" : null`, even with the [strict typing rule](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.0.md#properties) specified by OpenAPI 3.0:
+
+> default - The default value represents what would be assumed by the consumer of the input as the value of the schema if one is not provided. Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object defined at the same level. For example, if `type` is `string`, then `default` can be `"foo"` but cannot be `1`.
+
 ## Backwards compatibility
 
 Spec revisions through 3.0.2 are ambiguous as described above, so any possible clarification has the potential to break existing implementations.