OpenApiRouteHandlerBuilderExtensions.WithSummary<TBuilder> Method

Definition

Adds IEndpointSummaryMetadata to Metadata for all endpoints produced by builder.

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

Type Parameters

TBuilder

Parameters

builder
TBuilder

The IEndpointConventionBuilder.

summary
String

A string representing a brief description of the endpoint.

Returns

TBuilder

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

Applies to