# Interface OS3Paths
Interface| Module | import { OS3Paths } from "@tsed/openspec" |
|---|---|
| Source | /packages/specs/openspec/src/types/openspec3/OS3Paths.ts |
# Overview
interface OS3Paths<Schema = OS3Schema> extends OpenSpecPath<OS3Operation<Schema>> {
summary?<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">;</span>
description?<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">;</span>
trace?<span class="token punctuation">:</span> <a href="/api/specs/openspec/types/openspec3/OS3Operation.html"><span class="token">OS3Operation</span></a><<a href="/api/orm/mongoose/types/decorators/Schema.html"><span class="token">Schema</span></a>><span class="token punctuation">;</span>
servers?<span class="token punctuation">:</span> <a href="/api/specs/openspec/types/openspec3/OS3Server.html"><span class="token">OS3Server</span></a><span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">;</span>
parameters?<span class="token punctuation">:</span> <span class="token punctuation">(</span><a href="/api/specs/openspec/types/openspec3/OS3Parameter.html"><span class="token">OS3Parameter</span></a><<a href="/api/orm/mongoose/types/decorators/Schema.html"><span class="token">Schema</span></a>> | <a href="/api/specs/openspec/types/common/OpenSpecRef.html"><span class="token">OpenSpecRef</span></a><span class="token punctuation">)</span><span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">;</span>
}
# Members
summary?: string;An optional, string summary, intended to apply to all operations in this path.
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?: OS3Operation<Schema>;A definition of a TRACE operation on this path.
servers?: OS3Server[];An alternative server array to service all operations in this path.
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.