Sets request body required property to false when all action parameters are optional #591
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
Sets requestBody required property based on this evaluation. If all parameters are nullable, it sets the required value to false, otherwise it sets it to true
irvinesunday
requested review from
xuzhg,
darrelmiller,
danielmbaluka,
gavinbarron,
millicentachieng and
andrueastman
as code owners
andrueastman
reviewed
Oct 2, 2024
src/Microsoft.OpenApi.OData.Reader/Generator/OpenApiRequestBodyGenerator.cs
Outdated
Show resolved
Hide resolved
|
andrueastman
reviewed
Oct 2, 2024
| foreach (var parameter in action.Parameters.Skip(skip)) | ||
| { | ||
| allParamsNullable &= parameter.Type.IsNullable; |
There was a problem hiding this comment.
One last question here. Should we be checking if the parameter is of type IEdmOptionalParameter instead? Is it possible for required parameter to be nullable?
There was a problem hiding this comment.
Yes indeed! We should. I will add a check for the annotation: Org.OData.Core.V1.OptionalParameter
There was a problem hiding this comment.
I think for now let's only update the check to only cater for the annotation Org.OData.Core.V1.OptionalParameter as that's the scenario we want to cater for in #582. We can always come back and do that for nullable types.
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.
Fixes #582