@omer-x/openapi-types/dist/paths.d.ts

TypeScript types for the OpenAPI Specification

import type { OperationObject } from "./operation";
/**
 * Describes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.
 */
export type PathItemObject = {
    /**
     * Allows for a referenced definition of this path item. The referenced structure MUST be in the form of a Path Item Object. In case a Path Item Object field appears both in the defined object and the referenced object, the behavior is undefined. See the rules for resolving Relative References.
     */
    $ref?: string;
    /**
     * An optional, string summary, intended to apply to all operations in this path.
     */
    summary?: string;
    /**
     * An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.
     */
    description?: string;
    /**
     * A definition of a GET operation on this path.
     */
    get?: OperationObject;
    /**
     * A definition of a PUT operation on this path.
     */
    put?: OperationObject;
    /**
     * A definition of a POST operation on this path.
     */
    post?: OperationObject;
    /**
     * A definition of a DELETE operation on this path.
     */
    delete?: OperationObject;
    /**
     * A definition of a OPTIONS operation on this path.
     */
    options?: OperationObject;
    /**
     * A definition of a HEAD operation on this path.
     */
    head?: OperationObject;
    /**
     * A definition of a PATCH operation on this path.
     */
    patch?: OperationObject;
    /**
     * A definition of a TRACE operation on this path.
     */
    trace?: OperationObject;
    /**
     * An alternative server array to service all operations in this path.
     */
    servers?: unknown[];
    /**
     * 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. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object's components/parameters.
     */
    parameters?: unknown[];
};
/**
 * 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 MAY be empty, due to Access Control List (ACL) constraints.
 */
export type PathsObject = Record<string, PathItemObject>;