OpenApiRouteHandlerBuilderExtensions.WithTags Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
WithTags(RouteHandlerBuilder, String[]) |
Adds the ITagsMetadata to Metadata for all endpoints
produced by |
WithTags<TBuilder>(TBuilder, String[]) |
Adds the ITagsMetadata to Metadata for all endpoints
produced by |
WithTags(RouteHandlerBuilder, String[])
Adds the ITagsMetadata to Metadata for all endpoints
produced by builder
.
public static Microsoft.AspNetCore.Builder.RouteHandlerBuilder WithTags (this Microsoft.AspNetCore.Builder.RouteHandlerBuilder builder, params string[] tags);
static member WithTags : Microsoft.AspNetCore.Builder.RouteHandlerBuilder * string[] -> Microsoft.AspNetCore.Builder.RouteHandlerBuilder
<Extension()>
Public Function WithTags (builder As RouteHandlerBuilder, ParamArray tags As String()) As RouteHandlerBuilder
Parameters
- builder
- RouteHandlerBuilder
The RouteHandlerBuilder.
- tags
- String[]
A collection of tags to be associated with the endpoint.
Returns
A RouteHandlerBuilder that can be used to further customize the endpoint.
Remarks
The OpenAPI specification supports a tags classification to categorize operations into related groups. These tags are typically included in the generated specification and are typically used to group operations by tags in the UI.
Applies to
WithTags<TBuilder>(TBuilder, String[])
Adds the ITagsMetadata to Metadata for all endpoints
produced by builder
.
public static TBuilder WithTags<TBuilder> (this TBuilder builder, params string[] tags) where TBuilder : Microsoft.AspNetCore.Builder.IEndpointConventionBuilder;
static member WithTags : 'Builder * string[] -> 'Builder (requires 'Builder :> Microsoft.AspNetCore.Builder.IEndpointConventionBuilder)
<Extension()>
Public Function WithTags(Of TBuilder As IEndpointConventionBuilder) (builder As TBuilder, ParamArray tags As String()) As TBuilder
Type Parameters
- TBuilder
Parameters
- builder
- TBuilder
- tags
- String[]
A collection of tags to be associated with the endpoint.
Returns
A RouteHandlerBuilder that can be used to further customize the endpoint.
Remarks
The OpenAPI specification supports a tags classification to categorize operations into related groups. These tags are typically included in the generated specification and are typically used to group operations by tags in the UI.