-
Notifications
You must be signed in to change notification settings - Fork 10.7k
Unable to set route description or summary with minimal api #37906
Copy link
Copy link
Closed
Labels
Priority:0Work that we can't release withoutWork that we can't release withoutapi-approvedAPI was approved in API review, it can be implementedAPI was approved in API review, it can be implementedarea-minimalIncludes minimal APIs, endpoint filters, parameter binding, request delegate generator etcIncludes minimal APIs, endpoint filters, parameter binding, request delegate generator etcfeature-minimal-actionsController-like actions for endpoint routingController-like actions for endpoint routingfeature-openapiold-area-web-frameworks-do-not-use*DEPRECATED* This label is deprecated in favor of the area-mvc and area-minimal labels*DEPRECATED* This label is deprecated in favor of the area-mvc and area-minimal labels
Milestone
Metadata
Metadata
Assignees
Labels
Priority:0Work that we can't release withoutWork that we can't release withoutapi-approvedAPI was approved in API review, it can be implementedAPI was approved in API review, it can be implementedarea-minimalIncludes minimal APIs, endpoint filters, parameter binding, request delegate generator etcIncludes minimal APIs, endpoint filters, parameter binding, request delegate generator etcfeature-minimal-actionsController-like actions for endpoint routingController-like actions for endpoint routingfeature-openapiold-area-web-frameworks-do-not-use*DEPRECATED* This label is deprecated in favor of the area-mvc and area-minimal labels*DEPRECATED* This label is deprecated in favor of the area-mvc and area-minimal labels
Type
Fields
Give feedbackNo fields configured for issues without a type.
Is your feature request related to a problem? Please describe.
Hi, I am using the new minimal hosting model with dotnet 6 and I set up my endpoints like this:
Is there a way to set the summary of the route, so right next to the route -> underlined with red?
Is there a way to set the extended description of the route, so below the http method, in this case POST, and above the parameters section -> marked by the red arrow?
I already checked and there seem to only be the WithTags method or the AddMetaData where you could add EndpointNameMetadata
I think this feature is essential for providing a well structured and helpful api documentation.
Describe the solution you'd like
I would like to have the option to add the description either by having a dedicated method for that, so:
or to have attributes like the EndpointNameMetadata f.e.
EndpointDescriptionMetadatawhich can be used to set the OpenApi description of that route and be passed to theWithMetadata()method