OpenApiPathItemReference Class

Definition

Namespace:: Microsoft.OpenApi

Assembly:: Microsoft.OpenApi.dll

Package:: Microsoft.OpenApi v3.1.1

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

Path Item Object Reference: to describe the operations available on a single path.

public class OpenApiPathItemReference : Microsoft.OpenApi.BaseOpenApiReferenceHolder<Microsoft.OpenApi.OpenApiPathItem,Microsoft.OpenApi.IOpenApiPathItem,Microsoft.OpenApi.OpenApiReferenceWithDescriptionAndSummary>, Microsoft.OpenApi.IOpenApiPathItem, Microsoft.OpenApi.IShallowCopyable<Microsoft.OpenApi.IOpenApiPathItem>

type OpenApiPathItemReference = class
    inherit BaseOpenApiReferenceHolder<OpenApiPathItem, IOpenApiPathItem, OpenApiReferenceWithDescriptionAndSummary>
    interface IOpenApiPathItem
    interface IOpenApiDescribedElement
    interface IOpenApiElement
    interface IOpenApiSummarizedElement
    interface IOpenApiReadOnlyExtensible
    interface IShallowCopyable<IOpenApiPathItem>
    interface IOpenApiReferenceable
    interface IOpenApiSerializable

Public Class OpenApiPathItemReference
Inherits BaseOpenApiReferenceHolder(Of OpenApiPathItem, IOpenApiPathItem, OpenApiReferenceWithDescriptionAndSummary)
Implements IOpenApiPathItem, IShallowCopyable(Of IOpenApiPathItem)

Inheritance: Object

BaseOpenApiReferenceHolder<OpenApiPathItem,IOpenApiPathItem,OpenApiReferenceWithDescriptionAndSummary>
OpenApiPathItemReference

Implements: IOpenApiDescribedElement IOpenApiElement IOpenApiPathItem IOpenApiReadOnlyExtensible IOpenApiReferenceable IOpenApiSerializable IOpenApiSummarizedElement IShallowCopyable<IOpenApiPathItem>

Constructors

Name	Description
OpenApiPathItemReference(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.
Operations	Gets the definition of operations on this path.
Parameters	A list of parameters that are applicable for all the operations described under this path. These parameters can be overridden at the operation level, but cannot be removed there.
RecursiveTarget	Gets the recursively resolved target object. (Inherited from BaseOpenApiReferenceHolder<T,U,V>)
Reference	Reference object. (Inherited from BaseOpenApiReferenceHolder<T,U,V>)
Servers	An alternative server array to service all operations in this path.
Summary	Short description for the example.
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(OpenApiReferenceWithDescriptionAndSummary)	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(IOpenApiPathItem)	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