OpenApiLink Class

Reference

Definition

Namespace:: Microsoft.OpenApi.Models

Assembly:: Microsoft.OpenApi.dll

Package:: Microsoft.OpenApi v1.6.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.

Link Object.

public class OpenApiLink : Microsoft.OpenApi.Interfaces.IEffective<Microsoft.OpenApi.Models.OpenApiLink>, Microsoft.OpenApi.Interfaces.IOpenApiExtensible, Microsoft.OpenApi.Interfaces.IOpenApiReferenceable

type OpenApiLink = class
    interface IOpenApiSerializable
    interface IOpenApiElement
    interface IOpenApiReferenceable
    interface IOpenApiExtensible
    interface IEffective<OpenApiLink>

Public Class OpenApiLink
Implements IEffective(Of OpenApiLink), IOpenApiExtensible, IOpenApiReferenceable

Inheritance: Object
OpenApiLink

Implements: IEffective<OpenApiLink> IOpenApiElement IOpenApiExtensible IOpenApiReferenceable IOpenApiSerializable

Constructors

OpenApiLink()	Parameterless constructor
OpenApiLink(OpenApiLink)	Initializes a copy of an OpenApiLink object

Properties

Description	A description of the link.
Extensions	This object MAY be extended with Specification Extensions.
OperationId	The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field.
OperationRef	A relative or absolute reference to an OAS operation. This field is mutually exclusive of the operationId field, and MUST point to an Operation Object.
Parameters	A map representing parameters to pass to an operation as specified with operationId or identified via operationRef.
Reference	Reference pointer.
RequestBody	A literal value or {expression} to use as a request body when calling the target operation.
Server	A server object to be used by the target operation.
UnresolvedReference	Indicates if object is populated with data or is just a reference to the data

Methods

GetEffective(OpenApiDocument)	Returns an effective OpenApiLink object based on the presence of a $ref
SerializeAsV2(IOpenApiWriter)	Serialize OpenApiLink to Open Api v2.0
SerializeAsV2WithoutReference(IOpenApiWriter)	Serialize to OpenAPI V2 document without using reference.
SerializeAsV3(IOpenApiWriter)	Serialize OpenApiLink to Open Api v3.0
SerializeAsV3WithoutReference(IOpenApiWriter)	Serialize to OpenAPI V3 document without using reference.

Extension Methods

Validate(IOpenApiElement, ValidationRuleSet)	Validate element and all child elements
ResolveReference(IOpenApiReferenceable, JsonPointer)	Resolves a JSON Pointer with respect to an element, returning the referenced element.

Applies to

Share via