Support NRT and MSV in required and nullable
#1185
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
maurei
changed the title
maurei
force-pushed
the
openapi-required-and-nullable-properties
branch
from
a75fc23
to
916c753
Compare
maurei
changed the title
required
maurei
force-pushed
the
openapi-required-and-nullable-properties
branch
from
916c753
to
c55a2cb
Compare
Codecov Report
@@ Coverage Diff @@
## openapi #1185 +/- ##
===========================================
+ Coverage 92.65% 92.72% +0.06%
===========================================
Files 329 329
Lines 9863 9941 +78
===========================================
+ Hits 9139 9218 +79
+ Misses 724 723 -1
|
maurei
changed the title
requiredrequired and nullable
bkoelman
requested changes
Sep 8, 2022
There was a problem hiding this comment.
Very nice job! The implementation is straightforward and it's easy to verify the tests against what's in https://user-images.githubusercontent.com/9339132/177394179-2943249b-f5f1-4a72-adab-1c1d7ae85fc6.png. The code looks clean with good naming and structure.
The used models remind me of the Cow and Chicken series that my younger brother always watched! :)
src/JsonApiDotNetCore.OpenApi/SwaggerComponents/ResourceFieldObjectSchemaBuilder.cs
Outdated
Show resolved
Hide resolved
test/OpenApiTests/SchemaProperties/ModelStateValidationDisabledStartup.cs
Outdated
Show resolved
Hide resolved
...ApiTests/SchemaProperties/NullableReferenceTypesDisabled/ModelStateValidationEnabledTests.cs
Outdated
Show resolved
Hide resolved
...ApiTests/SchemaProperties/NullableReferenceTypesDisabled/ModelStateValidationEnabledTests.cs
Outdated
Show resolved
Hide resolved
...ApiTests/SchemaProperties/NullableReferenceTypesDisabled/ModelStateValidationEnabledTests.cs
Outdated
Show resolved
Hide resolved
test/OpenApiClientTests/SchemaProperties/NullableReferenceTypesEnabled/NullabilityTests.cs
Outdated
Show resolved
Hide resolved
test/OpenApiClientTests/SchemaProperties/NullableReferenceTypesDisabled/NullabilityTests.cs
Outdated
Show resolved
Hide resolved
...penApiClientTests/SchemaProperties/NullableReferenceTypesDisabled/RequiredAttributesTests.cs
Outdated
Show resolved
Hide resolved
src/JsonApiDotNetCore.OpenApi/SwaggerComponents/ResourceFieldObjectSchemaBuilder.cs
Show resolved
Hide resolved
...penApiClientTests/SchemaProperties/NullableReferenceTypesDisabled/RequiredAttributesTests.cs
Outdated
Show resolved
Hide resolved
…nd-nullable-properties
This comment was marked as resolved.
This comment was marked as resolved.
Merge openapi branch into PR 1185: Support NRT and MSV in required and nullable
OpenApiTests/SchemaProperties test collection: * Allow for usage of OpenApiStartup directly * Remove unneeded adding of JsonConverter * Replace null checks with .ShouldHaveCount() calls * Adjust test names Misc: * Reverted .editorconfig changes and fixed ApiException constructor instead * Remove Debug statement
|
The review items I've reacted to are processed in my latest commit. The other ones are related to something I'm still investigating and will follow |
maurei
force-pushed
the
openapi-required-and-nullable-properties
branch
2 times, most recently
from
d462a9d
to
589ad48
Compare
This comment was marked as resolved.
This comment was marked as resolved.
OpenAPI NRT/MSV updates
…inesAnalyzer v3.8.4
bkoelman
approved these changes
Oct 9, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduces improved support for
requiredandnullableproperties in OpenAPI schemas, by taking into account enabled/disabled nullable reference types and enabled/disabled model state validation. The table in Google Sheets (copy below) supersedes the original table from #1111.Includes:
NullabilityInfoContextto check nullability information rather than relying on Swashbuckles work-around (supersedes Use native NullabilityInfoContext #1167).OpenApiTestContextto allow for retrieving a swagger file without having to write it to disk.Closes #1111
Closes #1242
QUALITY CHECKLIST