IOpenApiDescribedElement 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 IOpenApiDescribedElement : Microsoft.OpenApi.IOpenApiElement

type IOpenApiDescribedElement = interface
    interface IOpenApiElement

Public Interface IOpenApiDescribedElement
Implements IOpenApiElement

Derived

Microsoft.OpenApi.IOpenApiExample

Microsoft.OpenApi.IOpenApiHeader

Microsoft.OpenApi.IOpenApiLink

Microsoft.OpenApi.IOpenApiParameter

Microsoft.OpenApi.IOpenApiPathItem

Microsoft.OpenApi.IOpenApiRequestBody

Microsoft.OpenApi.IOpenApiResponse

Microsoft.OpenApi.IOpenApiSchema

Microsoft.OpenApi.IOpenApiSecurityScheme

Microsoft.OpenApi.OpenApiExample

Microsoft.OpenApi.OpenApiExampleReference

Microsoft.OpenApi.OpenApiHeader

Microsoft.OpenApi.OpenApiHeaderReference

Microsoft.OpenApi.OpenApiLink

Microsoft.OpenApi.OpenApiLinkReference

Microsoft.OpenApi.OpenApiParameter

Microsoft.OpenApi.OpenApiParameterReference

Microsoft.OpenApi.OpenApiPathItem

Microsoft.OpenApi.OpenApiPathItemReference

Microsoft.OpenApi.OpenApiReferenceWithDescription

Microsoft.OpenApi.OpenApiRequestBody

Microsoft.OpenApi.OpenApiRequestBodyReference

Microsoft.OpenApi.OpenApiResponse

Microsoft.OpenApi.OpenApiResponseReference

Microsoft.OpenApi.OpenApiSchema

Microsoft.OpenApi.OpenApiSchemaReference

Microsoft.OpenApi.OpenApiSecurityScheme

Microsoft.OpenApi.OpenApiSecuritySchemeReference

Microsoft.OpenApi.OpenApiTag

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