OpenApiLinkReference Class

Definition

Namespace:: Microsoft.OpenApi

Assembly:: Microsoft.OpenApi.dll

Package:: Microsoft.OpenApi v3.1.1

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

Link Object Reference.

public class OpenApiLinkReference : Microsoft.OpenApi.BaseOpenApiReferenceHolder<Microsoft.OpenApi.OpenApiLink,Microsoft.OpenApi.IOpenApiLink,Microsoft.OpenApi.OpenApiReferenceWithDescription>, Microsoft.OpenApi.IOpenApiLink, Microsoft.OpenApi.IShallowCopyable<Microsoft.OpenApi.IOpenApiLink>

type OpenApiLinkReference = class
    inherit BaseOpenApiReferenceHolder<OpenApiLink, IOpenApiLink, OpenApiReferenceWithDescription>
    interface IOpenApiLink
    interface IOpenApiDescribedElement
    interface IOpenApiElement
    interface IOpenApiReadOnlyExtensible
    interface IShallowCopyable<IOpenApiLink>
    interface IOpenApiReferenceable
    interface IOpenApiSerializable

Public Class OpenApiLinkReference
Inherits BaseOpenApiReferenceHolder(Of OpenApiLink, IOpenApiLink, OpenApiReferenceWithDescription)
Implements IOpenApiLink, IShallowCopyable(Of IOpenApiLink)

Inheritance: Object

BaseOpenApiReferenceHolder<OpenApiLink,IOpenApiLink,OpenApiReferenceWithDescription>
OpenApiLinkReference

Implements: IOpenApiDescribedElement IOpenApiElement IOpenApiLink IOpenApiReadOnlyExtensible IOpenApiReferenceable IOpenApiSerializable IShallowCopyable<IOpenApiLink>

Constructors

Name	Description
OpenApiLinkReference(String, OpenApiDocument, String)	Constructor initializing the reference object.

Properties

Name	Description
Description	Long description for the example. CommonMark syntax MAY be used for rich text representation.
Extensions	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.
RecursiveTarget	Gets the recursively resolved target object. (Inherited from BaseOpenApiReferenceHolder<T,U,V>)
Reference	Reference object. (Inherited from BaseOpenApiReferenceHolder<T,U,V>)
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.
Target	Gets the resolved target object. (Inherited from BaseOpenApiReferenceHolder<T,U,V>)
UnresolvedReference	Indicates if object is populated with data or is just a reference to the data (Inherited from BaseOpenApiReferenceHolder<T,U,V>)

Methods

Name	Description
CopyReference(OpenApiReferenceWithDescription)	Copy the reference as a target element with overrides.
CopyReference(V)	Copy the reference as a target element with overrides. (Inherited from BaseOpenApiReferenceHolder<T,U,V>)
CopyReferenceAsTargetElementWithOverrides(IOpenApiLink)	Copy the reference as a target element with overrides.
CopyReferenceAsTargetElementWithOverrides(U)	Copy the reference as a target element with overrides. (Inherited from BaseOpenApiReferenceHolder<T,U,V>)
CreateShallowCopy()	Create a shallow copy of the current instance.
SerializeAsV2(IOpenApiWriter)	Serialize Open API element to v2.0.
SerializeAsV3(IOpenApiWriter)	Serialize Open API element to v3.0. (Inherited from BaseOpenApiReferenceHolder<T,U,V>)
SerializeAsV31(IOpenApiWriter)	Serialize OpenAPI element into v3.1 (Inherited from BaseOpenApiReferenceHolder<T,U,V>)
SerializeAsV32(IOpenApiWriter)	Serialize OpenAPI element into v3.2 (Inherited from BaseOpenApiReferenceHolder<T,U,V>)

Extension Methods

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

Applies to

Share via