OpenApiExternalDocs Class

Definition

Namespace:: Microsoft.OpenApi

Assembly:: Microsoft.OpenApi.dll

Package:: Microsoft.OpenApi v3.1.1

Source:: OpenApiExternalDocs.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.

ExternalDocs object.

public class OpenApiExternalDocs : Microsoft.OpenApi.IOpenApiExtensible, Microsoft.OpenApi.IOpenApiSerializable

type OpenApiExternalDocs = class
    interface IOpenApiSerializable
    interface IOpenApiElement
    interface IOpenApiExtensible

Public Class OpenApiExternalDocs
Implements IOpenApiExtensible, IOpenApiSerializable

Inheritance: Object
OpenApiExternalDocs

Implements: IOpenApiElement IOpenApiExtensible IOpenApiSerializable

Constructors

Name	Description
OpenApiExternalDocs()	Parameter-less constructor
OpenApiExternalDocs(OpenApiExternalDocs)	Initializes a copy of an OpenApiExternalDocs object

Properties

Name	Description
Description	A short description of the target documentation.
Extensions	This object MAY be extended with Specification Extensions.
Url	REQUIRED. The URL for the target documentation. Value MUST be in the format of a URL.

Methods

Name	Description
SerializeAsV2(IOpenApiWriter)	Serialize OpenApiExternalDocs to Open Api v2.0.
SerializeAsV3(IOpenApiWriter)	Serialize OpenApiExternalDocs to Open Api v3.0.
SerializeAsV31(IOpenApiWriter)	Serialize OpenApiExternalDocs to Open Api v3.1.
SerializeAsV32(IOpenApiWriter)	Serialize OpenApiExternalDocs to Open Api v3.2.

Extension Methods

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

Applies to

Share via