api-morph / PathsObject

Interface: PathsObject

Defined in: src/types/openapi.ts:310

Holds the relative paths to the individual endpoints and their operations. The path is appended to the URL from the Server Object in order to construct the full URL. The Paths Object MAY be empty, due to Access Control List (ACL) constraints.

See

https://spec.openapis.org/oas/v3.1.1#paths-object

Indexable

[path: string]: PathItemObject

A relative path to an individual endpoint. The field name MUST begin with a forward slash (/). The path is appended (no relative URL resolution) to the expanded URL from the Server Object's url field in order to construct the full URL. Path templating is allowed. When matching URLs, concrete (non-templated) paths would be matched before their templated counterparts. Templated paths with the same hierarchy but different templated names MUST NOT exist as they are identical. In case of ambiguous matching, it's up to the tooling to decide which one to use.

[key: `x-${string}`]: any

This object MAY be extended with Specification Extensions.