OS3Paths

@tsed/openspec

Usage

import { OS3Paths } from "@tsed/openspec";

See /packages/specs/openspec/src/types/openspec3/OS3Paths.ts.

Overview

interface OS3Paths<Schema = OS3Schema> extends OpenSpecPath<OS3Operation<Schema>> {
    summary?: string;
    description?: string;
    trace?: OS3Operation<Schema>;
    servers?: OS3Server[];
    parameters?: (OS3Parameter<Schema> | OpenSpecRef)[];
}

summary

summary?: string;

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

description

description?: string;

An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.

trace

trace?: OS3Operation<Schema>;

A definition of a TRACE operation on this path.

servers

servers?: OS3Server[];

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

parameters:

parameters?: (OS3Parameter<Schema> | OpenSpecRef)[];

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.