Share via


EndpointDescriptionAttribute Class

Definition

Specifies a description for the endpoint in Metadata.

[System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=false, Inherited=false)]
public sealed class EndpointDescriptionAttribute : Attribute, Microsoft.AspNetCore.Http.Metadata.IEndpointDescriptionMetadata
[<System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=false, Inherited=false)>]
type EndpointDescriptionAttribute = class
    inherit Attribute
    interface IEndpointDescriptionMetadata
Public NotInheritable Class EndpointDescriptionAttribute
Inherits Attribute
Implements IEndpointDescriptionMetadata
Inheritance
EndpointDescriptionAttribute
Attributes
Implements

Remarks

The OpenAPI specification supports a description attribute on operations and parameters that can be used to annotate endpoints with detailed, multiline descriptors of their behavior.

Constructors

EndpointDescriptionAttribute(String)

Initializes an instance of the EndpointDescriptionAttribute.

Properties

Description

Gets the description associated with the endpoint.

Methods

ToString() System.Attribute.ToString

Applies to