feat: enable null reference type support #2146

MaggieKimani1 · 2025-02-13T12:04:35Z

This PR:

Adds null reference type support by enabling the nullable feature in the core and readers project
Annotates all properties and method parameters/return types with ? for nullable types
Fixes compiler warnings such as possible dereferences of null values.

Fixes #1202

src/Microsoft.OpenApi/Extensions/EnumExtensions.cs

src/Microsoft.OpenApi/Reader/ParsingContext.cs

src/Microsoft.OpenApi/Reader/V31/OpenApiV31Deserializer.cs

src/Microsoft.OpenApi/Services/OpenApiWorkspace.cs

src/Microsoft.OpenApi/Validations/Rules/OpenApiSchemaRules.cs

src/Microsoft.OpenApi/Writers/OpenApiYamlWriter.cs

baywet

Great work here!
I've only done a partial review at this point starting with the interfaces, since changes there will require reviewing implementations again.

src/Microsoft.OpenApi/Interfaces/IOpenApiVersionService.cs

src/Microsoft.OpenApi/Interfaces/IOpenApiReferenceHolder.cs

src/Microsoft.OpenApi/Models/OpenApiExtensibleDictionary.cs

src/Microsoft.OpenApi/Models/OpenApiOperation.cs

src/Microsoft.OpenApi/Models/OpenApiReference.cs

src/Microsoft.OpenApi/Models/OpenApiRequestBody.cs

src/Microsoft.OpenApi/Models/OpenApiResponse.cs

Co-authored-by: Vincent Biret <[email protected]>

baywet

We're making good progress here, here is another set of comments

src/Microsoft.OpenApi/Any/OpenApiAny.cs

src/Microsoft.OpenApi/Attributes/DisplayAttribute.cs

src/Microsoft.OpenApi/Exceptions/OpenApiReaderException.cs

src/Microsoft.OpenApi/Exceptions/OpenApiUnsupportedSpecVersionException.cs

src/Microsoft.OpenApi/Models/OpenApiOperation.cs

src/Microsoft.OpenApi/Models/References/BaseOpenApiReferenceHolder.cs

src/Microsoft.OpenApi/Reader/OpenApiJsonReader.cs

src/Microsoft.OpenApi/Reader/ParseNodes/ListNode.cs

src/Microsoft.OpenApi/Services/OpenApiFilterService.cs

src/Microsoft.OpenApi/Services/OpenApiVisitorBase.cs

src/Microsoft.OpenApi/Services/OpenApiWorkspace.cs

src/Microsoft.OpenApi/Validations/OpenApiValidator.cs

src/Microsoft.OpenApi/Validations/ValidationRuleSet.cs

src/Microsoft.OpenApi/Writers/IOpenApiWriter.cs

src/Microsoft.OpenApi/Reader/V2/OpenApiDocumentDeserializer.cs

src/Microsoft.OpenApi/Reader/V2/OpenApiOperationDeserializer.cs

src/Microsoft.OpenApi/Reader/V2/OpenApiParameterDeserializer.cs

src/Microsoft.OpenApi/Reader/V2/OpenApiPathItemDeserializer.cs

src/Microsoft.OpenApi/Reader/V3/OpenApiServerVariableDeserializer.cs

src/Microsoft.OpenApi/Reader/V31/OpenApiSchemaDeserializer.cs

src/Microsoft.OpenApi/Reader/V31/OpenApiSecurityRequirementDeserializer.cs

src/Microsoft.OpenApi/Reader/V31/OpenApiServerVariableDeserializer.cs

src/Microsoft.OpenApi/Services/OpenApiWorkspace.cs

Co-authored-by: Vincent Biret <[email protected]>

…izer.cs Co-authored-by: Vincent Biret <[email protected]>

…erializer.cs Co-authored-by: Vincent Biret <[email protected]>

…rializer.cs Co-authored-by: Vincent Biret <[email protected]>

…zer.cs Co-authored-by: Vincent Biret <[email protected]>

…rializer.cs Co-authored-by: Vincent Biret <[email protected]>

sonarqubecloud · 2025-03-12T18:14:06Z

Please retry analysis of this Pull-Request directly on SonarQube Cloud

src/Microsoft.OpenApi/Writers/IOpenApiWriter.cs

src/Microsoft.OpenApi/Writers/OpenApiJsonWriter.cs

src/Microsoft.OpenApi/Writers/OpenApiWriterBase.cs

src/Microsoft.OpenApi/Services/OpenApiWalker.cs

baywet

Thank you for the great work and the long haul on this one!!!

sonarqubecloud · 2025-03-14T13:39:19Z

Quality Gate failed

Failed conditions
58.8% Coverage on New Code (required ≥ 80%)
28.1% Duplication on New Code (required ≤ 3%)

See analysis details on SonarQube Cloud

MaggieKimani1 added 3 commits February 13, 2025 14:42

feat: enable NRT

56bb532

fix: dereference of a possible null reference

b3b5663

Merge branch 'main' into feat/enable-NRT

c99dfc3

github-advanced-security bot found potential problems Feb 13, 2025

View reviewed changes

MaggieKimani1 added 2 commits February 14, 2025 15:47

chore: code cleanup

489fa4d

chore: convert to conditional expression

0b6b07d

MaggieKimani1 changed the title ~~feat: enable NRT~~ feat: enable null reference type support Feb 14, 2025

MaggieKimani1 marked this pull request as ready for review February 14, 2025 13:04

MaggieKimani1 requested review from irvinesunday, darrelmiller, gavinbarron, millicentachieng, andrueastman and baywet as code owners February 14, 2025 13:04

baywet requested changes Feb 14, 2025

View reviewed changes

Update src/Microsoft.OpenApi/Models/OpenApiOperation.cs

f13a9e4

Co-authored-by: Vincent Biret <[email protected]>

baywet mentioned this pull request Feb 20, 2025

adds support for OpenAPI 3.1 descriptions microsoft/kiota#5936

Merged

MaggieKimani1 and others added 7 commits February 21, 2025 11:07

Update src/Microsoft.OpenApi/Models/OpenApiRequestBody.cs

b7b845c

Co-authored-by: Vincent Biret <[email protected]>

chore: PR feedback

ea5c389

Merge branch 'main' into feat/enable-NRT

78b8d88

fix: resolve merge conflict errors

1b793a4

chore: remove deprecated code and tests; make param required

3df5c98

chore: code refactor and cleanup

69a2b9b

chore: update public API

2133509

baywet reviewed Feb 24, 2025

View reviewed changes

MaggieKimani1 added 5 commits February 25, 2025 14:12

chore: address PR comments

d990121

fix: remove nullable Json node params

80edd66

chore: use conditional compilation to make reference a required field

2749a3e

Merge branch 'main' into feat/enable-NRT

fa012ac

chore: resolve merge conflicts

d016afd

chore: resolve merge conflicts

ff0d877

baywet reviewed Mar 12, 2025

View reviewed changes

darrelmiller mentioned this pull request Mar 12, 2025

No difference between no security requirement and empty security requirement on Operations #1426

Closed

chore: more refactoring

2dcc72e

baywet reviewed Mar 12, 2025

View reviewed changes

MaggieKimani1 and others added 7 commits March 12, 2025 20:47

Update src/Microsoft.OpenApi/Reader/V2/OpenApiOperationDeserializer.cs

0aea73f

Co-authored-by: Vincent Biret <[email protected]>

Update src/Microsoft.OpenApi/Reader/V2/OpenApiPathItemDeserializer.cs

f942764

Co-authored-by: Vincent Biret <[email protected]>

Update src/Microsoft.OpenApi/Reader/V31/OpenApiServerVariableDeserial…

e545160

…izer.cs Co-authored-by: Vincent Biret <[email protected]>

Update src/Microsoft.OpenApi/Reader/V31/OpenApiSecurityRequirementDes…

6cc7497

…erializer.cs Co-authored-by: Vincent Biret <[email protected]>

Update src/Microsoft.OpenApi/Reader/V2/OpenApiSecurityRequirementDese…

93ac7f0

…rializer.cs Co-authored-by: Vincent Biret <[email protected]>

Update src/Microsoft.OpenApi/Reader/V3/OpenApiServerVariableDeseriali…

571b537

…zer.cs Co-authored-by: Vincent Biret <[email protected]>

Update src/Microsoft.OpenApi/Reader/V3/OpenApiSecurityRequirementDese…

69ef5c0

…rializer.cs Co-authored-by: Vincent Biret <[email protected]>

chore: another round of refactoring

81e0682

baywet reviewed Mar 13, 2025

View reviewed changes

src/Microsoft.OpenApi/Writers/IOpenApiWriter.cs Outdated Show resolved Hide resolved

src/Microsoft.OpenApi/Writers/OpenApiJsonWriter.cs Outdated Show resolved Hide resolved

src/Microsoft.OpenApi/Writers/OpenApiWriterBase.cs Outdated Show resolved Hide resolved

MaggieKimani1 added 6 commits March 13, 2025 22:06

chore: clean up nullability of params

d9a7bec

fix: compiler errors

32568e8

fix: remove redundant cast and update public API

f608cea

Merge branch 'main' into feat/enable-NRT

2f8ea28

chore: fix merge conflict issues

50b06c4

chore: apply copilot suggestion

c9b8f4f

baywet reviewed Mar 14, 2025

View reviewed changes

src/Microsoft.OpenApi/Services/OpenApiWalker.cs Outdated Show resolved Hide resolved

Update src/Microsoft.OpenApi/Services/OpenApiWalker.cs

2a12fa7

baywet approved these changes Mar 14, 2025

View reviewed changes

baywet enabled auto-merge (squash) March 14, 2025 13:34

baywet merged commit 96574ec into main Mar 14, 2025
10 of 13 checks passed

baywet deleted the feat/enable-NRT branch March 14, 2025 13:36

release-please bot mentioned this pull request Mar 14, 2025

chore(main): release 2.0.0-preview.13 #2240

Merged

andrueastman mentioned this pull request Mar 18, 2025

[V2] OpenApi Schema are not serialized with ReadOnly property for 2.0 documents when the schema is not a property. #2272

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: enable null reference type support #2146

feat: enable null reference type support #2146

MaggieKimani1 commented Feb 13, 2025 •

edited

Loading

baywet left a comment

baywet left a comment

sonarqubecloud bot commented Mar 12, 2025

baywet left a comment

sonarqubecloud bot commented Mar 14, 2025

feat: enable null reference type support #2146

feat: enable null reference type support #2146

Conversation

MaggieKimani1 commented Feb 13, 2025 • edited Loading

baywet left a comment

Choose a reason for hiding this comment

baywet left a comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Mar 12, 2025

baywet left a comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Mar 14, 2025

Quality Gate failed

MaggieKimani1 commented Feb 13, 2025 •

edited

Loading