# Interface OS3Components
InterfaceModule | import { OS3Components } from "@tsed/openspec" |
---|---|
Source | /packages/specs/openspec/src/types/openspec3/OS3Components.ts |
# Overview
interface OS3Components<Schema = OS3Schema> {
schemas?<span class="token punctuation">:</span> <a href="/api/specs/openspec/types/common/OpenSpecHash.html"><span class="token">OpenSpecHash</span></a><<a href="/api/orm/mongoose/types/decorators/Schema.html"><span class="token">Schema</span></a>><span class="token punctuation">;</span>
responses?<span class="token punctuation">:</span> <a href="/api/specs/openspec/types/common/OpenSpecHash.html"><span class="token">OpenSpecHash</span></a><<a href="/api/specs/openspec/types/openspec3/OS3Response.html"><span class="token">OS3Response</span></a><<a href="/api/orm/mongoose/types/decorators/Schema.html"><span class="token">Schema</span></a>>><span class="token punctuation">;</span>
parameters?<span class="token punctuation">:</span> <a href="/api/specs/openspec/types/common/OpenSpecHash.html"><span class="token">OpenSpecHash</span></a><<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>>><span class="token punctuation">;</span>
examples?<span class="token punctuation">:</span> <a href="/api/specs/openspec/types/common/OpenSpecHash.html"><span class="token">OpenSpecHash</span></a><<a href="/api/specs/openspec/types/openspec3/OS3Example.html"><span class="token">OS3Example</span></a>><span class="token punctuation">;</span>
requestBodies?<span class="token punctuation">:</span> <a href="/api/specs/openspec/types/common/OpenSpecHash.html"><span class="token">OpenSpecHash</span></a><<a href="/api/specs/openspec/types/openspec3/OS3RequestBody.html"><span class="token">OS3RequestBody</span></a><<a href="/api/orm/mongoose/types/decorators/Schema.html"><span class="token">Schema</span></a>>><span class="token punctuation">;</span>
headers?<span class="token punctuation">:</span> <a href="/api/specs/openspec/types/common/OpenSpecHash.html"><span class="token">OpenSpecHash</span></a><<a href="/api/specs/openspec/types/openspec3/OS3Header.html"><span class="token">OS3Header</span></a><<a href="/api/orm/mongoose/types/decorators/Schema.html"><span class="token">Schema</span></a>>><span class="token punctuation">;</span>
securitySchemes?<span class="token punctuation">:</span> <a href="/api/specs/openspec/types/common/OpenSpecHash.html"><span class="token">OpenSpecHash</span></a><<a href="/api/specs/openspec/types/openspec3/OS3Security.html"><span class="token">OS3Security</span></a>><span class="token punctuation">;</span>
links?<span class="token punctuation">:</span> <a href="/api/specs/openspec/types/common/OpenSpecHash.html"><span class="token">OpenSpecHash</span></a><<a href="/api/specs/openspec/types/openspec3/OS3Link.html"><span class="token">OS3Link</span></a>><span class="token punctuation">;</span>
callbacks?<span class="token punctuation">:</span> <a href="/api/specs/openspec/types/openspec3/OS3Callbacks.html"><span class="token">OS3Callbacks</span></a><span class="token punctuation">;</span>
}
# Members
schemas?: OpenSpecHash<Schema>;
An object to hold reusable Schema Objects
responses?: OpenSpecHash<OS3Response<Schema>>;
An object to hold reusable Response Objects
parameters?: OpenSpecHash<OS3Parameter<Schema>>;
An object to hold reusable Parameter Objects
examples?: OpenSpecHash<OS3Example>;
An object to hold reusable Example Objects
requestBodies?: OpenSpecHash<OS3RequestBody<Schema>>;
An object to hold reusable Request Body Objects
headers?: OpenSpecHash<OS3Header<Schema>>;
An object to hold reusable Header Objects
securitySchemes?: OpenSpecHash<OS3Security>;
An object to hold reusable Security Scheme Objects
links?: OpenSpecHash<OS3Link>;
An object to hold reusable Link Objects
callbacks?: OS3Callbacks;
An object to hold reusable Callback Objects