OasPathItem
OasPathItem is an object containing shared data for an OpenAPI path item. Rather than acting as a parent object for all methods as it does in OpenAPI, it is instead a container for the shared properties of a path item and is available as a property of each OasOperation object.
Properties
Property | Type | Description |
---|---|---|
oasType | 'pathItem' | Static value representing the OpenAPI path item type. |
description | string | undefined | Optional description of the path item. |
summary | string | undefined | Optional summary of the path item. |
servers | OasServer[] | undefined | Optional servers for the path item. |
parameters | OasParameter[] | undefined | Optional parameters for the path item. |
extensionFields | Record<string, unknown> | undefined | Optional map of custom fields defined by OpenAPI extensions. Keys are strings beginning with x- and values are of any valid JSON type. |