OpenApiRouteHandlerBuilderExtensions.WithTags Method

Definition

Namespace:

Microsoft.AspNetCore.Http

Assembly:

Microsoft.AspNetCore.Routing.dll

Package:

Microsoft.AspNetCore.App.Ref v8.0.0

Overloads

WithTags(RouteHandlerBuilder, String[])	Adds the ITagsMetadata to Metadata for all endpoints produced by builder.
WithTags<TBuilder>(TBuilder, String[])	Adds the ITagsMetadata to Metadata for all endpoints produced by builder.

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

RouteHandlerBuilder

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.

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

The IEndpointConventionBuilder.

tags

String[]

A collection of tags to be associated with the endpoint.

Returns

TBuilder

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.