Share via


OpenApiPathItem Class

Definition

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

public class OpenApiPathItem : Microsoft.OpenApi.Interfaces.IEffective<Microsoft.OpenApi.Models.OpenApiPathItem>, Microsoft.OpenApi.Interfaces.IOpenApiExtensible, Microsoft.OpenApi.Interfaces.IOpenApiReferenceable
type OpenApiPathItem = class
    interface IOpenApiSerializable
    interface IOpenApiElement
    interface IOpenApiExtensible
    interface IOpenApiReferenceable
    interface IEffective<OpenApiPathItem>
Public Class OpenApiPathItem
Implements IEffective(Of OpenApiPathItem), IOpenApiExtensible, IOpenApiReferenceable
Inheritance
OpenApiPathItem
Implements

Constructors

OpenApiPathItem()

Parameterless constructor

OpenApiPathItem(OpenApiPathItem)

Initializes a clone of an OpenApiPathItem object

Properties

Description

An optional, string description, intended to apply to all operations in this path.

Extensions

This object MAY be extended with 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.

Reference

Reference object.

Servers

An alternative server array to service all operations in this path.

Summary

An optional, string summary, intended to apply to all operations in this path.

UnresolvedReference

Indicates if object is populated with data or is just a reference to the data

Methods

AddOperation(OperationType, OpenApiOperation)

Add one operation into this path item.

GetEffective(OpenApiDocument)

Returns an effective OpenApiPathItem object based on the presence of a $ref

SerializeAsV2(IOpenApiWriter)

Serialize OpenApiPathItem to Open Api v2.0

SerializeAsV2WithoutReference(IOpenApiWriter)

Serialize inline PathItem in OpenAPI V2

SerializeAsV3(IOpenApiWriter)

Serialize OpenApiPathItem to Open Api v3.0

SerializeAsV3WithoutReference(IOpenApiWriter)

Serialize inline PathItem in OpenAPI V3

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