OpenApiRouteHandlerBuilderExtensions.WithSummary<TBuilder> Method

Reference

Definition

Namespace:: Microsoft.AspNetCore.Http

Assembly:: Microsoft.AspNetCore.Routing.dll

Package:: Microsoft.AspNetCore.App.Ref v7.0.5

Package:: Microsoft.AspNetCore.App.Ref v8.0.0

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.

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