Share via

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.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.0
Package:
Microsoft.AspNetCore.App.Ref v9.0.0-rc.2.24474.3

Overloads

ExcludeFromDescription(RouteHandlerBuilder)

Adds the IExcludeFromDescriptionMetadata to Metadata for all endpoints produced by builder.
ExcludeFromDescription<TBuilder>(TBuilder)

Adds the IExcludeFromDescriptionMetadata to Metadata for all endpoints produced by builder.

ExcludeFromDescription(RouteHandlerBuilder)

Source:
OpenApiRouteHandlerBuilderExtensions.cs

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

ExcludeFromDescription<TBuilder>(TBuilder)

Source:
OpenApiRouteHandlerBuilderExtensions.cs

Adds the IExcludeFromDescriptionMetadata to Metadata for all endpoints produced by builder.

public static TBuilder ExcludeFromDescription<TBuilder> (this TBuilder builder) where TBuilder : Microsoft.AspNetCore.Builder.IEndpointConventionBuilder;
static member ExcludeFromDescription : 'Builder -> 'Builder (requires 'Builder :> Microsoft.AspNetCore.Builder.IEndpointConventionBuilder)
<Extension()>
Public Function ExcludeFromDescription(Of TBuilder As IEndpointConventionBuilder) (builder As TBuilder) As TBuilder

Type Parameters

TBuilder

Parameters

builder
TBuilder

The IEndpointConventionBuilder.

Returns

TBuilder

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

Applies to