Share via

ExcludeFromDescriptionAttribute Class

Definition

Namespace:
Microsoft.AspNetCore.Routing
Assembly:
Microsoft.AspNetCore.Routing.dll
Package:
Microsoft.AspNetCore.App.Ref v10.0.0-preview.7.25380.108
Package:
Microsoft.AspNetCore.App.Ref v6.0.6
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:
ExcludeFromDescriptionAttribute.cs

Indicates that this Endpoint should not be included in the generated API metadata.

[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Delegate | System.AttributeTargets.Method, AllowMultiple=false, Inherited=true)]
public sealed class ExcludeFromDescriptionAttribute : Attribute, Microsoft.AspNetCore.Routing.IExcludeFromDescriptionMetadata
[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Delegate | System.AttributeTargets.Method, AllowMultiple=false, Inherited=true)>]
type ExcludeFromDescriptionAttribute = class
    inherit Attribute
    interface IExcludeFromDescriptionMetadata
Public NotInheritable Class ExcludeFromDescriptionAttribute
Inherits Attribute
Implements IExcludeFromDescriptionMetadata
Inheritance
Attribute
ExcludeFromDescriptionAttribute
Attributes
AttributeUsageAttribute
Implements
IExcludeFromDescriptionMetadata

Constructors

ExcludeFromDescriptionAttribute()

Properties

ExcludeFromDescription

Gets a value indicating whether OpenAPI data should be excluded for this endpoint. If true, API metadata is not emitted.

Methods

ToString() System.Attribute.ToString

Applies to