Interface PathItem

A pathItem, keyed in paths by its uriTemplate. Each request is an operation (SPEC §1.3/1.4).

interface PathItem {
    summary?: string;
    description?: string;
    servers?: Server[];
    shared?: Shared;
    requests: Record<string, Request>;
    pathResponses?: Record<string, Response>;
}

Index

Properties

summary? description? servers? shared? requests pathResponses?

Properties

`Optional`summary

summary?: string

`Optional`description

description?: string

`Optional`servers

servers?: Server[]

`Optional`shared

shared?: Shared

Optional per-level inheritance wrapper (C012 #116).

requests

requests: Record<string, Request>

The operations at this path, keyed by stable name (C009). At least one required.

`Optional`pathResponses

pathResponses?: Record<string, Response>

Responses reusable across this pathItem's requests (§5).