Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

OpenApiRouteHandlerBuilderExtensions.WithDescription<TBuilder> Method

Definition

Namespace:
Microsoft.AspNetCore.Http
Assembly:
Microsoft.AspNetCore.Routing.dll
Package:
Microsoft.AspNetCore.App.Ref v10.0.0
Package:
Microsoft.AspNetCore.App.Ref v11.0.0-preview.4.26230.115
Package:
Microsoft.AspNetCore.App.Ref v7.0.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.19
Package:
Microsoft.AspNetCore.App.Ref v9.0.8
Source:
OpenApiRouteHandlerBuilderExtensions.cs

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 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

Feedback

Was this page helpful?