IOpenApiLink Interface

Definition

Namespace:: Microsoft.OpenApi

Assembly:: Microsoft.OpenApi.dll

Package:: Microsoft.OpenApi v3.1.1

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

Defines the base properties for the link object. This interface is provided for type assertions but should not be implemented by package consumers beyond automatic mocking.

public interface IOpenApiLink : Microsoft.OpenApi.IOpenApiDescribedElement, Microsoft.OpenApi.IOpenApiReadOnlyExtensible, Microsoft.OpenApi.IOpenApiReferenceable, Microsoft.OpenApi.IShallowCopyable<Microsoft.OpenApi.IOpenApiLink>

type IOpenApiLink = interface
    interface IOpenApiDescribedElement
    interface IOpenApiElement
    interface IOpenApiReadOnlyExtensible
    interface IShallowCopyable<IOpenApiLink>
    interface IOpenApiReferenceable
    interface IOpenApiSerializable

Public Interface IOpenApiLink
Implements IOpenApiDescribedElement, IOpenApiReadOnlyExtensible, IOpenApiReferenceable, IShallowCopyable(Of IOpenApiLink)

Derived: Microsoft.OpenApi.OpenApiLink

Microsoft.OpenApi.OpenApiLinkReference

Implements: IOpenApiDescribedElement IOpenApiElement IOpenApiReadOnlyExtensible IOpenApiReferenceable IOpenApiSerializable IShallowCopyable<IOpenApiLink>

Properties

Name	Description
Description	Long description for the example. CommonMark syntax MAY be used for rich text representation. (Inherited from IOpenApiDescribedElement)
Extensions	Specification extensions. (Inherited from IOpenApiReadOnlyExtensible)
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.
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.

Methods

Name	Description
CreateShallowCopy()	Create a shallow copy of the current instance. (Inherited from IShallowCopyable<T>)
SerializeAsV2(IOpenApiWriter)	Serialize Open API element to v2.0. (Inherited from IOpenApiSerializable)
SerializeAsV3(IOpenApiWriter)	Serialize Open API element to v3.0. (Inherited from IOpenApiSerializable)
SerializeAsV31(IOpenApiWriter)	Serialize OpenAPI element into v3.1 (Inherited from IOpenApiSerializable)
SerializeAsV32(IOpenApiWriter)	Serialize OpenAPI element into v3.2 (Inherited from IOpenApiSerializable)

Extension Methods

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

Applies to