OpenApiExternalDocs Class

Definition

ExternalDocs object.

public class OpenApiExternalDocs : Microsoft.OpenApi.Interfaces.IOpenApiExtensible, Microsoft.OpenApi.Interfaces.IOpenApiSerializable
type OpenApiExternalDocs = class
    interface IOpenApiSerializable
    interface IOpenApiElement
    interface IOpenApiExtensible
Public Class OpenApiExternalDocs
Implements IOpenApiExtensible, IOpenApiSerializable
Inheritance
OpenApiExternalDocs
Implements

Constructors

OpenApiExternalDocs()

Parameter-less constructor

OpenApiExternalDocs(OpenApiExternalDocs)

Initializes a copy of an OpenApiExternalDocs object

Properties

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

SerializeAsV2(IOpenApiWriter)

Serialize OpenApiExternalDocs to Open Api v2.0.

SerializeAsV3(IOpenApiWriter)

Serialize OpenApiExternalDocs to Open Api v3.0.

Extension Methods

Validate(IOpenApiElement, ValidationRuleSet)

Validate element and all child elements

Applies to