Skip to content

Set required parameter attribute in OpenAPI metadata #35081

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

Jump to bottom
Closed
captainsafia opened this issue Aug 5, 2021 · 1 comment · Fixed by #35233
Closed

Set required parameter attribute in OpenAPI metadata #35081

captainsafia opened this issue Aug 5, 2021 · 1 comment · Fixed by #35233
Assignees
@davidfowl
Labels
area-minimal Includes minimal APIs, endpoint filters, parameter binding, request delegate generator etc feature-minimal-actions Controller-like actions for endpoint routing old-area-web-frameworks-do-not-use *DEPRECATED* This label is deprecated in favor of the area-mvc and area-minimal labels
Milestone
6.0-rc1

Comments

@captainsafia
Copy link
Member

By default, OpenAPI assumes that all parameters are optional parameters.

https://swagger.io/docs/specification/describing-parameters/

We don't currently propagate any information that says required: true for parameters that are required in an endpoint

This builds on top of the work done in #32375
@captainsafia captainsafia added the old-area-web-frameworks-do-not-use *DEPRECATED* This label is deprecated in favor of the area-mvc and area-minimal labels label Aug 5, 2021
@rafikiassumani-msft rafikiassumani-msft added the feature-minimal-actions Controller-like actions for endpoint routing label Aug 6, 2021
@rafikiassumani-msft rafikiassumani-msft mentioned this issue Aug 6, 2021
Closed
@rafikiassumani-msft rafikiassumani-msft added this to the 6.0-rc1 milestone Aug 9, 2021
@davidfowl
Copy link
Member

davidfowl commented Aug 10, 2021 •
edited
Loading

Turns out this requires changes in 2 places:

@davidfowl davidfowl mentioned this issue Aug 10, 2021
Merged
@ghost ghost locked as resolved and limited conversation to collaborators Sep 11, 2021
@amcasey amcasey added the area-minimal Includes minimal APIs, endpoint filters, parameter binding, request delegate generator etc label Jun 2, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@davidfowl davidfowl

Labels
area-minimal Includes minimal APIs, endpoint filters, parameter binding, request delegate generator etc feature-minimal-actions Controller-like actions for endpoint routing old-area-web-frameworks-do-not-use *DEPRECATED* This label is deprecated in favor of the area-mvc and area-minimal labels
Projects
None yet
Milestone
6.0-rc1
Development

Successfully merging a pull request may close this issue.

Set IsRequired on ApiDescriptions for endpoints dotnet/aspnetcore
4 participants
@davidfowl @captainsafia @amcasey @rafikiassumani-msft