OpenApiRouteHandlerBuilderExtensions.ExcludeFromDescription Method

Reference

Definition

Namespace:: Microsoft.AspNetCore.Http

Assembly:: Microsoft.AspNetCore.Routing.dll

Package:: Microsoft.AspNetCore.App.Ref v6.0.6

Package:: Microsoft.AspNetCore.App.Ref v7.0.0-preview.5.22303.8

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 the IExcludeFromDescriptionMetadata to Metadata for all endpoints produced by builder.

public static Microsoft.AspNetCore.Builder.RouteHandlerBuilder ExcludeFromDescription (this Microsoft.AspNetCore.Builder.RouteHandlerBuilder builder);

static member ExcludeFromDescription : Microsoft.AspNetCore.Builder.RouteHandlerBuilder -> Microsoft.AspNetCore.Builder.RouteHandlerBuilder

<Extension()>
Public Function ExcludeFromDescription (builder As RouteHandlerBuilder) As RouteHandlerBuilder

Parameters

builder: RouteHandlerBuilder

The RouteHandlerBuilder.

Returns

RouteHandlerBuilder

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

Applies to