Skip to content

Support ASP.NET Core 2.2 Default Parameter Value in API Explorer #414

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
commonsensesoftware opened this issue Dec 16, 2018 · 0 comments
Closed

Support ASP.NET Core 2.2 Default Parameter Value in API Explorer #414

commonsensesoftware opened this issue Dec 16, 2018 · 0 comments
Assignees
@commonsensesoftware
Labels
asp.net core feature
Milestone
3.1

Comments

@commonsensesoftware
Copy link
Collaborator

The ASP.NET Core API Explorer design did not include metadata to describe whether a parameter is required and what the default value is, unless it was defined as a route parameter. ApiParameterDescription was updated in ASP.NET Core 2.2 to include new properties to support this information.

Requirements

  • Support ApiParameterDescription.IsRequired
  • Support ApiParameterDescription.DefaultValue
  • Fix ApiParameterDescription.RouteInfo so that ApiParameterRouteInfo.DefaultValue is only used when the value actually a route parameter (ex: versioning by URL segment)
@commonsensesoftware commonsensesoftware self-assigned this Dec 16, 2018
@commonsensesoftware commonsensesoftware added this to the 3.1 milestone Dec 16, 2018
@commonsensesoftware commonsensesoftware changed the title Support ASP.NET 2.2 Default Parameter Value in API Explorer Support ASP.NET Core 2.2 Default Parameter Value in API Explorer Dec 16, 2018
commonsensesoftware pushed a commit that referenced this issue Dec 21, 2018
Support IsRequired and DefaultValue added to ApiParameterDescription. R…
cac4a98 
…esolves #414.
@commonsensesoftware commonsensesoftware mentioned this issue Dec 22, 2018
Merged
commonsensesoftware pushed a commit that referenced this issue Dec 22, 2018
@commonsensesoftware
Support IsRequired and DefaultValue added to ApiParameterDescription. R…
32ec618 
…esolves #414.
@CumpsD CumpsD mentioned this issue Dec 30, 2018
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@commonsensesoftware commonsensesoftware

Labels
asp.net core feature
Projects
None yet
Milestone
3.1
Development

No branches or pull requests
1 participant
@commonsensesoftware