UNPKG

@sleekify/sleekify

Version:

A TypeScript decorator driven approach for developing web applications.

github.com/sleekify/sleekify

sleekify/sleekify

17 lines (16 loc) • 801 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
import { type ComponentsObject } from '../types/types'; /** * You may apply this decorator to your resource class to annotate the class * with reusable OpenAPI components which may be referenced in your OpenAPI * specification. These components include things like path parameters, query * parameters, schemas, and headers. You may provide a path such as * "#/components/schemas/Pet" where ever the OpenAPI specification accepts a * reference object. * * Once you define a reusable component with this decorator, that component may * be referenced by the same resource class or any of your other resource * classes. * * @param componentsObject The OpenAPI components object definition */ export declare function Components(componentsObject: ComponentsObject): (target: object) => void;