Skip to content

Adds nullable to double schema conversions #589

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 1, 2024
Merged

Adds nullable to double schema conversions #589

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ef87d3c
Update double schema
irvinesunday Sep 30, 2024
28ea7bb
Update integration file tests
irvinesunday Sep 30, 2024
543ed88
Update release notes
irvinesunday Sep 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/Microsoft.OpenApi.OData.Reader/Generator/OpenApiEdmTypeSchemaGenerator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
8 changes: 5 additions & 3 deletions src/Microsoft.OpenApi.OData.Reader/Generator/OpenApiSchemaGenerator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,12 +121,14 @@

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)
Expand Down Expand Up @@ -631,7 +633,7 @@
// properties
foreach (var property in structuredType.Properties())
{
// IOpenApiAny item;

Check warning on line 636 in src/Microsoft.OpenApi.OData.Reader/Generator/OpenApiSchemaGenerator.cs

View workflow job for this annotation

GitHub Actions / Build 

Remove this commented out code. (https://rules.sonarsource.com/csharp/RSPEC-125)
IEdmTypeReference propertyType = property.Type;

IOpenApiAny item = GetTypeNameForExample(context, propertyType);
Expand Down Expand Up @@ -757,7 +759,7 @@
// The type 'System.Double' is not supported in Open API document.
case EdmPrimitiveTypeKind.Double:
/*
{

Check warning on line 762 in src/Microsoft.OpenApi.OData.Reader/Generator/OpenApiSchemaGenerator.cs

View workflow job for this annotation

GitHub Actions / Build 

Remove this commented out code. (https://rules.sonarsource.com/csharp/RSPEC-125)
double result;
if (Double.TryParse(property.DefaultValueString, out result))
{
Expand Down
3 changes: 2 additions & 1 deletion src/Microsoft.OpenApi.OData.Reader/Microsoft.OpenAPI.OData.Reader.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<TargetFrameworks>net8.0</TargetFrameworks>
<PackageId>Microsoft.OpenApi.OData</PackageId>
<SignAssembly>true</SignAssembly>
<Version>2.0.0-preview.2</Version>
<Version>2.0.0-preview.3</Version>
<Description>This package contains the codes you need to convert OData CSDL to Open API Document of Model.</Description>
<Copyright>© Microsoft Corporation. All rights reserved.</Copyright>
<PackageTags>Microsoft OpenApi OData EDM</PackageTags>
Expand All @@ -25,6 +25,7 @@
- Cleaned up obsolete APIs
- Changed target framework to net8.0
- Adds support for retrieving collection of enum values from UpdateMethod property of UpdateRestrictions annotation #564
- Adds nullable to double schema conversions #581
</PackageReleaseNotes>
<AssemblyName>Microsoft.OpenApi.OData.Reader</AssemblyName>
<AssemblyOriginatorKeyFile>..\..\tool\Microsoft.OpenApi.OData.snk</AssemblyOriginatorKeyFile>
Expand Down
6 changes: 4 additions & 2 deletions test/Microsoft.OpenAPI.OData.Reader.Tests/Generator/OpenApiSchemaGeneratorTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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""
Expand Down
3 changes: 2 additions & 1 deletion test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Basic.OpenApi.V2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1152,7 +1152,8 @@
"-INF",
"INF",
"NaN"
]
],
"type": "string"
}
},
"parameters": {
Expand Down
1 change: 1 addition & 0 deletions test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Basic.OpenApi.V2.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -757,6 +757,7 @@ definitions:
- '-INF'
- INF
- NaN
type: string
parameters:
top:
in: query
Expand Down
4 changes: 3 additions & 1 deletion test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Basic.OpenApi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1258,7 +1258,9 @@
"-INF",
"INF",
"NaN"
]
],
"type": "string",
"nullable": true
}
},
"responses": {
Expand Down
2 changes: 2 additions & 0 deletions test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Basic.OpenApi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -829,6 +829,8 @@ components:
- '-INF'
- INF
- NaN
type: string
nullable: true
responses:
error:
description: error
Expand Down
3 changes: 2 additions & 1 deletion test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Empty.OpenApi.V2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,8 @@
"-INF",
"INF",
"NaN"
]
],
"type": "string"
}
},
"parameters": {
Expand Down
1 change: 1 addition & 0 deletions test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Empty.OpenApi.V2.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ definitions:
- '-INF'
- INF
- NaN
type: string
parameters:
top:
in: query
Expand Down
4 changes: 3 additions & 1 deletion test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Empty.OpenApi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,9 @@
"-INF",
"INF",
"NaN"
]
],
"type": "string",
"nullable": true
}
},
"responses": {
Expand Down
2 changes: 2 additions & 0 deletions test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Empty.OpenApi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,8 @@ components:
- '-INF'
- INF
- NaN
type: string
nullable: true
responses:
error:
description: error
Expand Down
3 changes: 2 additions & 1 deletion test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Multiple.Schema.OpenApi.V2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6118,7 +6118,8 @@
"-INF",
"INF",
"NaN"
]
],
"type": "string"
}
},
"parameters": {
Expand Down
1 change: 1 addition & 0 deletions test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Multiple.Schema.OpenApi.V2.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4436,6 +4436,7 @@ definitions:
- '-INF'
- INF
- NaN
type: string
parameters:
top:
in: query
Expand Down
4 changes: 3 additions & 1 deletion test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Multiple.Schema.OpenApi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6835,7 +6835,9 @@
"-INF",
"INF",
"NaN"
]
],
"type": "string",
"nullable": true
}
},
"responses": {
Expand Down
2 changes: 2 additions & 0 deletions test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Multiple.Schema.OpenApi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4921,6 +4921,8 @@ components:
- '-INF'
- INF
- NaN
type: string
nullable: true
responses:
error:
description: error
Expand Down
3 changes: 2 additions & 1 deletion test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/TripService.OpenApi.V2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31561,7 +31561,8 @@
"-INF",
"INF",
"NaN"
]
],
"type": "string"
}
},
"parameters": {
Expand Down
1 change: 1 addition & 0 deletions test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/TripService.OpenApi.V2.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21393,6 +21393,7 @@ definitions:
- '-INF'
- INF
- NaN
type: string
parameters:
top:
in: query
Expand Down
16 changes: 11 additions & 5 deletions test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/TripService.OpenApi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1397,10 +1397,12 @@
"oneOf": [
{
"type": "number",
"format": "double"
"format": "double",
"nullable": true
},
{
"type": "string"
"type": "string",
"nullable": true
},
{
"$ref": "#/components/schemas/ReferenceNumeric"
Expand All @@ -1416,10 +1418,12 @@
"oneOf": [
{
"type": "number",
"format": "double"
"format": "double",
"nullable": true
},
{
"type": "string"
"type": "string",
"nullable": true
},
{
"$ref": "#/components/schemas/ReferenceNumeric"
Expand Down Expand Up @@ -35293,7 +35297,9 @@
"-INF",
"INF",
"NaN"
]
],
"type": "string",
"nullable": true
}
},
"responses": {
Expand Down
6 changes: 6 additions & 0 deletions test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/TripService.OpenApi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -914,7 +914,9 @@ paths:
oneOf:
- type: number
format: double
nullable: true
- type: string
nullable: true
- $ref: '#/components/schemas/ReferenceNumeric'
- name: lon
in: path
Expand All @@ -923,7 +925,9 @@ paths:
oneOf:
- type: number
format: double
nullable: true
- type: string
nullable: true
- $ref: '#/components/schemas/ReferenceNumeric'
responses:
'200':
Expand Down Expand Up @@ -23713,6 +23717,8 @@ components:
- '-INF'
- INF
- NaN
type: string
nullable: true
responses:
error:
description: error
Expand Down
Loading