IOpenApiReadOnlyDescribedElement Interface

Definition

Namespace:

Microsoft.OpenApi

Assembly:

Microsoft.OpenApi.dll

Package:

Microsoft.OpenApi v3.1.1

Source:

IOpenApiDescribedElement.cs

Describes an element that has a description.

public interface IOpenApiReadOnlyDescribedElement : Microsoft.OpenApi.IOpenApiElement

type IOpenApiReadOnlyDescribedElement = interface
    interface IOpenApiElement

Public Interface IOpenApiReadOnlyDescribedElement
Implements IOpenApiElement

Derived

Microsoft.OpenApi.IOpenApiTag

Microsoft.OpenApi.OpenApiTag

Microsoft.OpenApi.OpenApiTagReference

Implements

IOpenApiElement

Properties

Name	Description
Description	Long description for the example. CommonMark syntax MAY be used for rich text representation.

Extension Methods

Name	Description
Validate(IOpenApiElement, ValidationRuleSet)	Validate element and all child elements