EndpointDescriptionAttribute Class

Reference

Definition

Namespace:: Microsoft.AspNetCore.Http

Assembly:: Microsoft.AspNetCore.Http.Extensions.dll

Package:: Microsoft.AspNetCore.App.Ref v7.0.5

Package:: Microsoft.AspNetCore.App.Ref v8.0.0

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: Attribute
EndpointDescriptionAttribute

Attributes: AttributeUsageAttribute

Implements: IEndpointDescriptionMetadata

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