OpenApiRouteHandlerBuilderExtensions.WithDescription<TBuilder> Method

Definition

Adds IEndpointDescriptionMetadata to Metadata for all endpoints produced by builder.

public static TBuilder WithDescription<TBuilder> (this TBuilder builder, string description) where TBuilder : Microsoft.AspNetCore.Builder.IEndpointConventionBuilder;
static member WithDescription : 'Builder * string -> 'Builder (requires 'Builder :> Microsoft.AspNetCore.Builder.IEndpointConventionBuilder)
<Extension()>
Public Function WithDescription(Of TBuilder As IEndpointConventionBuilder) (builder As TBuilder, description As String) As TBuilder

Type Parameters

TBuilder

Parameters

builder
TBuilder

The IEndpointConventionBuilder.

description
String

A string representing a detailed description of the endpoint.

Returns

TBuilder

A RouteHandlerBuilder that can be used to further customize the endpoint.

Applies to