Adds nullable to double schema conversions (#589)

irvinesunday · baywet · commit 14e498016c7e · 2024-12-24T12:23:26.000-05:00
* Update double schema

* Update integration file tests

* Update release notes
diff --git a/src/Microsoft.OpenApi.OData.Reader/Generator/OpenApiEdmTypeSchemaGenerator.cs b/src/Microsoft.OpenApi.OData.Reader/Generator/OpenApiEdmTypeSchemaGenerator.cs
@@ -195,8 +195,8 @@ public static OpenApiSchema CreateSchema(this ODataContext context, IEdmPrimitiv
                 case EdmPrimitiveTypeKind.Double: // double
                     schema.OneOf = new List<OpenApiSchema>
                     {
-                        new OpenApiSchema { Type = Constants.NumberType, Format = "double" },
-                        new OpenApiSchema { Type = Constants.StringType },
+                        new OpenApiSchema { Type = Constants.NumberType, Format = "double", Nullable = true },
+                        new OpenApiSchema { Type = Constants.StringType, Nullable = true },
                         new OpenApiSchema
                         {
                             UnresolvedReference = true,
diff --git a/src/Microsoft.OpenApi.OData.Reader/Generator/OpenApiSchemaGenerator.cs b/src/Microsoft.OpenApi.OData.Reader/Generator/OpenApiSchemaGenerator.cs
@@ -121,12 +121,14 @@ public static IDictionary<string, OpenApiSchema> CreateSchemas(this ODataContext
 
             schemas[Constants.ReferenceNumericName] = new()
             {
-                Enum = new List<IOpenApiAny>
-                {
+                Type = Constants.StringType,
+                Nullable = true,
+                Enum =
+                [
                     new OpenApiString("-INF"),
                     new OpenApiString("INF"),
                     new OpenApiString("NaN")
-                }
+                ]
             };
 
             if (context.Settings.EnableODataAnnotationReferencesForResponses)
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Generator/OpenApiSchemaGeneratorTests.cs b/test/Microsoft.OpenAPI.OData.Reader.Tests/Generator/OpenApiSchemaGeneratorTests.cs
@@ -1105,10 +1105,12 @@ public void NonNullableDoublePropertyWithDefaultStringWorks()
   ""oneOf"": [
     {
       ""type"": ""number"",
-      ""format"": ""double""
+      ""format"": ""double"",
+      ""nullable"": true
     },
     {
-      ""type"": ""string""
+      ""type"": ""string"",
+      ""nullable"": true
     },
     {
       ""$ref"": ""#/components/schemas/ReferenceNumeric""
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Basic.OpenApi.V2.json b/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Basic.OpenApi.V2.json
@@ -1152,7 +1152,8 @@
         "-INF",
         "INF",
         "NaN"
-      ]
+      ],
+      "type": "string"
     }
   },
   "parameters": {
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Basic.OpenApi.V2.yaml b/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Basic.OpenApi.V2.yaml
@@ -757,6 +757,7 @@ definitions:
       - '-INF'
       - INF
       - NaN
+    type: string
 parameters:
   top:
     in: query
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Basic.OpenApi.json b/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Basic.OpenApi.json
@@ -1258,7 +1258,9 @@
           "-INF",
           "INF",
           "NaN"
-        ]
+        ],
+        "type": "string",
+        "nullable": true
       }
     },
     "responses": {
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Basic.OpenApi.yaml b/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Basic.OpenApi.yaml
@@ -829,6 +829,8 @@ components:
         - '-INF'
         - INF
         - NaN
+      type: string
+      nullable: true
   responses:
     error:
       description: error
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Empty.OpenApi.V2.json b/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Empty.OpenApi.V2.json
@@ -103,7 +103,8 @@
         "-INF",
         "INF",
         "NaN"
-      ]
+      ],
+      "type": "string"
     }
   },
   "parameters": {
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Empty.OpenApi.V2.yaml b/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Empty.OpenApi.V2.yaml
@@ -71,6 +71,7 @@ definitions:
       - '-INF'
       - INF
       - NaN
+    type: string
 parameters:
   top:
     in: query
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Empty.OpenApi.json b/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Empty.OpenApi.json
@@ -108,7 +108,9 @@
           "-INF",
           "INF",
           "NaN"
-        ]
+        ],
+        "type": "string",
+        "nullable": true
       }
     },
     "responses": {
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Empty.OpenApi.yaml b/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Empty.OpenApi.yaml
@@ -74,6 +74,8 @@ components:
         - '-INF'
         - INF
         - NaN
+      type: string
+      nullable: true
   responses:
     error:
       description: error
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Multiple.Schema.OpenApi.V2.json b/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Multiple.Schema.OpenApi.V2.json
@@ -6118,7 +6118,8 @@
         "-INF",
         "INF",
         "NaN"
-      ]
+      ],
+      "type": "string"
     }
   },
   "parameters": {
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Multiple.Schema.OpenApi.V2.yaml b/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Multiple.Schema.OpenApi.V2.yaml
@@ -4436,6 +4436,7 @@ definitions:
       - '-INF'
       - INF
       - NaN
+    type: string
 parameters:
   top:
     in: query
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Multiple.Schema.OpenApi.json b/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Multiple.Schema.OpenApi.json
@@ -6835,7 +6835,9 @@
           "-INF",
           "INF",
           "NaN"
-        ]
+        ],
+        "type": "string",
+        "nullable": true
       }
     },
     "responses": {
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Multiple.Schema.OpenApi.yaml b/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Multiple.Schema.OpenApi.yaml
@@ -4921,6 +4921,8 @@ components:
         - '-INF'
         - INF
         - NaN
+      type: string
+      nullable: true
   responses:
     error:
       description: error
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/TripService.OpenApi.V2.json b/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/TripService.OpenApi.V2.json
@@ -31561,7 +31561,8 @@
         "-INF",
         "INF",
         "NaN"
-      ]
+      ],
+      "type": "string"
     }
   },
   "parameters": {
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/TripService.OpenApi.V2.yaml b/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/TripService.OpenApi.V2.yaml
@@ -21393,6 +21393,7 @@ definitions:
       - '-INF'
       - INF
       - NaN
+    type: string
 parameters:
   top:
     in: query
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/TripService.OpenApi.json b/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/TripService.OpenApi.json
@@ -1397,10 +1397,12 @@
               "oneOf": [
                 {
                   "type": "number",
-                  "format": "double"
+                  "format": "double",
+                  "nullable": true
                 },
                 {
-                  "type": "string"
+                  "type": "string",
+                  "nullable": true
                 },
                 {
                   "$ref": "#/components/schemas/ReferenceNumeric"
@@ -1416,10 +1418,12 @@
               "oneOf": [
                 {
                   "type": "number",
-                  "format": "double"
+                  "format": "double",
+                  "nullable": true
                 },
                 {
-                  "type": "string"
+                  "type": "string",
+                  "nullable": true
                 },
                 {
                   "$ref": "#/components/schemas/ReferenceNumeric"
@@ -35293,7 +35297,9 @@
           "-INF",
           "INF",
           "NaN"
-        ]
+        ],
+        "type": "string",
+        "nullable": true
       }
     },
     "responses": {
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/TripService.OpenApi.yaml b/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/TripService.OpenApi.yaml
@@ -914,7 +914,9 @@ paths:
             oneOf:
               - type: number
                 format: double
+                nullable: true
               - type: string
+                nullable: true
               - $ref: '#/components/schemas/ReferenceNumeric'
         - name: lon
           in: path
@@ -923,7 +925,9 @@ paths:
             oneOf:
               - type: number
                 format: double
+                nullable: true
               - type: string
+                nullable: true
               - $ref: '#/components/schemas/ReferenceNumeric'
       responses:
         '200':
@@ -23713,6 +23717,8 @@ components:
         - '-INF'
         - INF
         - NaN
+      type: string
+      nullable: true
   responses:
     error:
       description: error

Original file line number	Diff line number	Diff line change
`@@ -195,8 +195,8 @@ public static OpenApiSchema CreateSchema(this ODataContext context, IEdmPrimitiv`
`195`	`195`	`case EdmPrimitiveTypeKind.Double: // double`
`196`	`196`	`schema.OneOf = new List<OpenApiSchema>`
`197`	`197`	`{`
`198`		`- new OpenApiSchema { Type = Constants.NumberType, Format = "double" },`
`199`		`- new OpenApiSchema { Type = Constants.StringType },`
	`198`	`+ new OpenApiSchema { Type = Constants.NumberType, Format = "double", Nullable = true },`
	`199`	`+ new OpenApiSchema { Type = Constants.StringType, Nullable = true },`
`200`	`200`	`new OpenApiSchema`
`201`	`201`	`{`
`202`	`202`	`UnresolvedReference = true,`
Original file line number	Diff line number	Diff line change
`@@ -1105,10 +1105,12 @@ public void NonNullableDoublePropertyWithDefaultStringWorks()`
`1105`	`1105`	`""oneOf"": [`
`1106`	`1106`	`{`
`1107`	`1107`	`""type"": ""number"",`
`1108`		`- ""format"": ""double""`
	`1108`	`+ ""format"": ""double"",`
	`1109`	`+ ""nullable"": true`
`1109`	`1110`	`},`
`1110`	`1111`	`{`
`1111`		`- ""type"": ""string""`
	`1112`	`+ ""type"": ""string"",`
	`1113`	`+ ""nullable"": true`
`1112`	`1114`	`},`
`1113`	`1115`	`{`
`1114`	`1116`	`""$ref"": ""#/components/schemas/ReferenceNumeric""`
Original file line number	Diff line number	Diff line change
`@@ -1397,10 +1397,12 @@`
`1397`	`1397`	`"oneOf": [`
`1398`	`1398`	`{`
`1399`	`1399`	`"type": "number",`
`1400`		`- "format": "double"`
	`1400`	`+ "format": "double",`
	`1401`	`+ "nullable": true`
`1401`	`1402`	`},`
`1402`	`1403`	`{`
`1403`		`- "type": "string"`
	`1404`	`+ "type": "string",`
	`1405`	`+ "nullable": true`
`1404`	`1406`	`},`
`1405`	`1407`	`{`
`1406`	`1408`	`"$ref": "#/components/schemas/ReferenceNumeric"`
`@@ -1416,10 +1418,12 @@`
`1416`	`1418`	`"oneOf": [`
`1417`	`1419`	`{`
`1418`	`1420`	`"type": "number",`
`1419`		`- "format": "double"`
	`1421`	`+ "format": "double",`
	`1422`	`+ "nullable": true`
`1420`	`1423`	`},`
`1421`	`1424`	`{`
`1422`		`- "type": "string"`
	`1425`	`+ "type": "string",`
	`1426`	`+ "nullable": true`
`1423`	`1427`	`},`
`1424`	`1428`	`{`
`1425`	`1429`	`"$ref": "#/components/schemas/ReferenceNumeric"`
`@@ -35293,7 +35297,9 @@`
`35293`	`35297`	`"-INF",`
`35294`	`35298`	`"INF",`
`35295`	`35299`	`"NaN"`
`35296`		`- ]`
	`35300`	`+ ],`
	`35301`	`+ "type": "string",`
	`35302`	`+ "nullable": true`
`35297`	`35303`	`}`
`35298`	`35304`	`},`
`35299`	`35305`	`"responses": {`