Note

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

Access to this page requires authorization. You can try .

EndpointDescriptionAttribute Class

Definition

Namespace:
Microsoft.AspNetCore.Http
Assembly:
Microsoft.AspNetCore.Http.Extensions.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:
EndpointDescriptionAttribute.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.

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

Name Description
EndpointDescriptionAttribute(String)

Initializes an instance of the EndpointDescriptionAttribute.

Properties

Name Description
Description

Gets the description associated with the endpoint.

Methods

Name Description
ToString() System.Attribute.ToString

Applies to

Feedback

Was this page helpful?