@loopback/openapi-v3
Advanced tools
Comparing version 0.10.5 to 0.10.6
@@ -6,2 +6,13 @@ # Change Log | ||
<a name="0.10.6"></a> | ||
## [0.10.6](https://github.com/strongloop/loopback-next/compare/@loopback/openapi-v3@0.10.5...@loopback/openapi-v3@0.10.6) (2018-06-08) | ||
### Bug Fixes | ||
* make the code compatible with TypeScript 2.9.x ([37aba50](https://github.com/strongloop/loopback-next/commit/37aba50)) | ||
<a name="0.10.5"></a> | ||
@@ -8,0 +19,0 @@ ## [0.10.5](https://github.com/strongloop/loopback-next/compare/@loopback/openapi-v3@0.10.4...@loopback/openapi-v3@0.10.5) (2018-05-28) |
@@ -18,3 +18,3 @@ import { ParameterObject, ParameterLocation, ReferenceObject, SchemaObject } from '@loopback/openapi-v3-types'; | ||
*/ | ||
export declare function param(paramSpec: ParameterObject): (target: Object, member: string | symbol, index: number) => void; | ||
export declare function param(paramSpec: ParameterObject): (target: Object, member: string, index: number) => void; | ||
/** | ||
@@ -43,42 +43,262 @@ * | ||
const query: { | ||
string: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
number: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
boolean: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
integer: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
long: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
float: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
double: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
byte: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
binary: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
date: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
dateTime: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
password: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
/** | ||
* Define a parameter of "integer" type that's read from the query string. | ||
* Usage: ` @param.query.string('paramName')` | ||
* | ||
* @param name Parameter name. | ||
*/ | ||
string: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "number" type that's read from the query string. | ||
* Usage: ` @param.query.number('paramName')` | ||
* | ||
* @param name Parameter name. | ||
*/ | ||
number: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "boolean" type that's read from the query string. | ||
* Usage: ` @param.query.boolean('paramName')` | ||
* | ||
* @param name Parameter name. | ||
*/ | ||
boolean: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "integer" type that's read from the query string. | ||
* Usage: ` @param.query.integer('paramName')` | ||
* | ||
* @param name Parameter name. | ||
*/ | ||
integer: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "long" type that's read from the query string. | ||
* Usage: ` @param.query.long('paramName')` | ||
* | ||
* @param name Parameter name. | ||
*/ | ||
long: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "float" type that's read from the query string. | ||
* Usage: ` @param.query.float('paramName')` | ||
* | ||
* @param name Parameter name. | ||
*/ | ||
float: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "double" type that's read from the query string. | ||
* Usage: ` @param.query.double('paramName')` | ||
* | ||
* @param name Parameter name. | ||
*/ | ||
double: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "byte" type that's read from the query string. | ||
* Usage: ` @param.query.byte('paramName')` | ||
* | ||
* @param name Parameter name. | ||
*/ | ||
byte: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "binary" type that's read from the query string. | ||
* Usage: ` @param.query.binary('paramName')` | ||
* | ||
* @param name Parameter name. | ||
*/ | ||
binary: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "date" type that's read from the query string. | ||
* Usage: ` @param.query.date('paramName')` | ||
* | ||
* @param name Parameter name. | ||
*/ | ||
date: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "dateTime" type that's read from the query string. | ||
* Usage: ` @param.query.dateTime('paramName')` | ||
* | ||
* @param name Parameter name. | ||
*/ | ||
dateTime: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "password" type that's read from the query string. | ||
* Usage: ` @param.query.password('paramName')` | ||
* | ||
* @param name Parameter name. | ||
*/ | ||
password: (name: string) => (target: Object, member: string, index: number) => void; | ||
}; | ||
const header: { | ||
string: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
number: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
boolean: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
integer: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
long: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
float: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
double: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
byte: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
binary: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
date: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
dateTime: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
password: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
/** | ||
* Define a parameter of "string" type that's read from a request header. | ||
* Usage: ` @param.header.string('paramName')` | ||
* | ||
* @param name Parameter name, it must match the header name | ||
* (e.g. `Content-Type`). | ||
*/ | ||
string: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "number" type that's read from a request header. | ||
* Usage: ` @param.header.number('paramName')` | ||
* | ||
* @param name Parameter name, it must match the header name | ||
* (e.g. `Content-Length`). | ||
*/ | ||
number: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "boolean" type that's read from a request header. | ||
* Usage: ` @param.header.boolean('paramName')` | ||
* | ||
* @param name Parameter name, it must match the header name | ||
* (e.g. `DNT` or `X-Do-Not-Track`). | ||
*/ | ||
boolean: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "integer" type that's read from a request header. | ||
* Usage: ` @param.header.integer('paramName')` | ||
* | ||
* @param name Parameter name, it must match the header name | ||
* (e.g. `Content-Length`). | ||
*/ | ||
integer: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "long" type that's read from a request header. | ||
* Usage: ` @param.header.long('paramName')` | ||
* | ||
* @param name Parameter name, it must match the header name | ||
*/ | ||
long: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "float" type that's read from a request header. | ||
* Usage: ` @param.header.float('paramName')` | ||
* | ||
* @param name Parameter name, it must match the header name | ||
*/ | ||
float: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "double" type that's read from a request header. | ||
* Usage: ` @param.header.double('paramName')` | ||
* | ||
* @param name Parameter name, it must match the header name | ||
*/ | ||
double: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "byte" type that's read from a request header. | ||
* Usage: ` @param.header.byte('paramName')` | ||
* | ||
* @param name Parameter name, it must match the header name | ||
*/ | ||
byte: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "binary" type that's read from a request header. | ||
* Usage: ` @param.header.binary('paramName')` | ||
* | ||
* @param name Parameter name, it must match the header name | ||
*/ | ||
binary: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "date" type that's read from a request header. | ||
* Usage: ` @param.header.date('paramName')` | ||
* | ||
* @param name Parameter name, it must match the header name | ||
*/ | ||
date: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "dateTime" type that's read from a request header. | ||
* Usage: ` @param.header.dateTime('paramName')` | ||
* | ||
* @param name Parameter name, it must match the header name | ||
*/ | ||
dateTime: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "password" type that's read from a request header. | ||
* Usage: ` @param.header.password('paramName')` | ||
* | ||
* @param name Parameter name, it must match the header name | ||
*/ | ||
password: (name: string) => (target: Object, member: string, index: number) => void; | ||
}; | ||
const path: { | ||
string: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
number: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
boolean: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
integer: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
long: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
float: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
double: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
byte: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
binary: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
date: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
dateTime: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
password: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
/** | ||
* Define a parameter of "string" type that's read from request path. | ||
* Usage: ` @param.path.string('paramName')` | ||
* | ||
* @param name Parameter name matching one of the placeholders in the path | ||
*/ | ||
string: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "number" type that's read from request path. | ||
* Usage: ` @param.path.number('paramName')` | ||
* | ||
* @param name Parameter name matching one of the placeholders in the path | ||
*/ | ||
number: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "boolean" type that's read from request path. | ||
* Usage: ` @param.path.boolean('paramName')` | ||
* | ||
* @param name Parameter name matching one of the placeholders in the path | ||
*/ | ||
boolean: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "integer" type that's read from request path. | ||
* Usage: ` @param.path.integer('paramName')` | ||
* | ||
* @param name Parameter name matching one of the placeholders in the path | ||
*/ | ||
integer: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "long" type that's read from request path. | ||
* Usage: ` @param.path.long('paramName')` | ||
* | ||
* @param name Parameter name matching one of the placeholders in the path | ||
*/ | ||
long: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "float" type that's read from request path. | ||
* Usage: ` @param.path.float('paramName')` | ||
* | ||
* @param name Parameter name matching one of the placeholders in the path | ||
*/ | ||
float: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "double" type that's read from request path. | ||
* Usage: ` @param.path.double('paramName')` | ||
* | ||
* @param name Parameter name matching one of the placeholders in the path | ||
*/ | ||
double: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "byte" type that's read from request path. | ||
* Usage: ` @param.path.byte('paramName')` | ||
* | ||
* @param name Parameter name matching one of the placeholders in the path | ||
*/ | ||
byte: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "binary" type that's read from request path. | ||
* Usage: ` @param.path.binary('paramName')` | ||
* | ||
* @param name Parameter name matching one of the placeholders in the path | ||
*/ | ||
binary: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "date" type that's read from request path. | ||
* Usage: ` @param.path.date('paramName')` | ||
* | ||
* @param name Parameter name matching one of the placeholders in the path | ||
*/ | ||
date: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "dateTime" type that's read from request path. | ||
* Usage: ` @param.path.dateTime('paramName')` | ||
* | ||
* @param name Parameter name matching one of the placeholders in the path | ||
*/ | ||
dateTime: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "password" type that's read from request path. | ||
* Usage: ` @param.path.password('paramName')` | ||
* | ||
* @param name Parameter name matching one of the placeholders in the path | ||
*/ | ||
password: (name: string) => (target: Object, member: string, index: number) => void; | ||
}; | ||
@@ -102,3 +322,3 @@ /** | ||
*/ | ||
const array: (name: string, source: ParameterLocation, itemSpec: SchemaObject | ReferenceObject) => (target: Object, member: string | symbol, index: number) => void; | ||
const array: (name: string, source: ParameterLocation, itemSpec: SchemaObject | ReferenceObject) => (target: Object, member: string, index: number) => void; | ||
} |
@@ -63,3 +63,3 @@ import { RequestBodyObject, SchemaObject, ReferenceObject } from '@loopback/openapi-v3-types'; | ||
*/ | ||
export declare function requestBody(requestBodySpec?: Partial<RequestBodyObject>): (target: Object, member: string | symbol, index: number) => void; | ||
export declare function requestBody(requestBodySpec?: Partial<RequestBodyObject>): (target: Object, member: string, index: number) => void; | ||
export declare namespace requestBody { | ||
@@ -88,3 +88,3 @@ /** | ||
required?: boolean | undefined; | ||
} | undefined) => (target: Object, member: string | symbol, index: number) => void; | ||
} | undefined) => (target: Object, member: string, index: number) => void; | ||
} |
@@ -18,3 +18,3 @@ import { ParameterObject, ParameterLocation, ReferenceObject, SchemaObject } from '@loopback/openapi-v3-types'; | ||
*/ | ||
export declare function param(paramSpec: ParameterObject): (target: Object, member: string | symbol, index: number) => void; | ||
export declare function param(paramSpec: ParameterObject): (target: Object, member: string, index: number) => void; | ||
/** | ||
@@ -43,42 +43,262 @@ * | ||
const query: { | ||
string: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
number: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
boolean: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
integer: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
long: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
float: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
double: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
byte: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
binary: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
date: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
dateTime: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
password: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
/** | ||
* Define a parameter of "integer" type that's read from the query string. | ||
* Usage: ` @param.query.string('paramName')` | ||
* | ||
* @param name Parameter name. | ||
*/ | ||
string: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "number" type that's read from the query string. | ||
* Usage: ` @param.query.number('paramName')` | ||
* | ||
* @param name Parameter name. | ||
*/ | ||
number: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "boolean" type that's read from the query string. | ||
* Usage: ` @param.query.boolean('paramName')` | ||
* | ||
* @param name Parameter name. | ||
*/ | ||
boolean: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "integer" type that's read from the query string. | ||
* Usage: ` @param.query.integer('paramName')` | ||
* | ||
* @param name Parameter name. | ||
*/ | ||
integer: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "long" type that's read from the query string. | ||
* Usage: ` @param.query.long('paramName')` | ||
* | ||
* @param name Parameter name. | ||
*/ | ||
long: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "float" type that's read from the query string. | ||
* Usage: ` @param.query.float('paramName')` | ||
* | ||
* @param name Parameter name. | ||
*/ | ||
float: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "double" type that's read from the query string. | ||
* Usage: ` @param.query.double('paramName')` | ||
* | ||
* @param name Parameter name. | ||
*/ | ||
double: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "byte" type that's read from the query string. | ||
* Usage: ` @param.query.byte('paramName')` | ||
* | ||
* @param name Parameter name. | ||
*/ | ||
byte: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "binary" type that's read from the query string. | ||
* Usage: ` @param.query.binary('paramName')` | ||
* | ||
* @param name Parameter name. | ||
*/ | ||
binary: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "date" type that's read from the query string. | ||
* Usage: ` @param.query.date('paramName')` | ||
* | ||
* @param name Parameter name. | ||
*/ | ||
date: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "dateTime" type that's read from the query string. | ||
* Usage: ` @param.query.dateTime('paramName')` | ||
* | ||
* @param name Parameter name. | ||
*/ | ||
dateTime: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "password" type that's read from the query string. | ||
* Usage: ` @param.query.password('paramName')` | ||
* | ||
* @param name Parameter name. | ||
*/ | ||
password: (name: string) => (target: Object, member: string, index: number) => void; | ||
}; | ||
const header: { | ||
string: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
number: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
boolean: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
integer: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
long: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
float: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
double: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
byte: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
binary: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
date: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
dateTime: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
password: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
/** | ||
* Define a parameter of "string" type that's read from a request header. | ||
* Usage: ` @param.header.string('paramName')` | ||
* | ||
* @param name Parameter name, it must match the header name | ||
* (e.g. `Content-Type`). | ||
*/ | ||
string: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "number" type that's read from a request header. | ||
* Usage: ` @param.header.number('paramName')` | ||
* | ||
* @param name Parameter name, it must match the header name | ||
* (e.g. `Content-Length`). | ||
*/ | ||
number: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "boolean" type that's read from a request header. | ||
* Usage: ` @param.header.boolean('paramName')` | ||
* | ||
* @param name Parameter name, it must match the header name | ||
* (e.g. `DNT` or `X-Do-Not-Track`). | ||
*/ | ||
boolean: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "integer" type that's read from a request header. | ||
* Usage: ` @param.header.integer('paramName')` | ||
* | ||
* @param name Parameter name, it must match the header name | ||
* (e.g. `Content-Length`). | ||
*/ | ||
integer: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "long" type that's read from a request header. | ||
* Usage: ` @param.header.long('paramName')` | ||
* | ||
* @param name Parameter name, it must match the header name | ||
*/ | ||
long: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "float" type that's read from a request header. | ||
* Usage: ` @param.header.float('paramName')` | ||
* | ||
* @param name Parameter name, it must match the header name | ||
*/ | ||
float: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "double" type that's read from a request header. | ||
* Usage: ` @param.header.double('paramName')` | ||
* | ||
* @param name Parameter name, it must match the header name | ||
*/ | ||
double: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "byte" type that's read from a request header. | ||
* Usage: ` @param.header.byte('paramName')` | ||
* | ||
* @param name Parameter name, it must match the header name | ||
*/ | ||
byte: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "binary" type that's read from a request header. | ||
* Usage: ` @param.header.binary('paramName')` | ||
* | ||
* @param name Parameter name, it must match the header name | ||
*/ | ||
binary: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "date" type that's read from a request header. | ||
* Usage: ` @param.header.date('paramName')` | ||
* | ||
* @param name Parameter name, it must match the header name | ||
*/ | ||
date: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "dateTime" type that's read from a request header. | ||
* Usage: ` @param.header.dateTime('paramName')` | ||
* | ||
* @param name Parameter name, it must match the header name | ||
*/ | ||
dateTime: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "password" type that's read from a request header. | ||
* Usage: ` @param.header.password('paramName')` | ||
* | ||
* @param name Parameter name, it must match the header name | ||
*/ | ||
password: (name: string) => (target: Object, member: string, index: number) => void; | ||
}; | ||
const path: { | ||
string: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
number: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
boolean: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
integer: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
long: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
float: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
double: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
byte: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
binary: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
date: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
dateTime: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
password: (name: string) => (target: Object, member: string | symbol, index: number) => void; | ||
/** | ||
* Define a parameter of "string" type that's read from request path. | ||
* Usage: ` @param.path.string('paramName')` | ||
* | ||
* @param name Parameter name matching one of the placeholders in the path | ||
*/ | ||
string: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "number" type that's read from request path. | ||
* Usage: ` @param.path.number('paramName')` | ||
* | ||
* @param name Parameter name matching one of the placeholders in the path | ||
*/ | ||
number: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "boolean" type that's read from request path. | ||
* Usage: ` @param.path.boolean('paramName')` | ||
* | ||
* @param name Parameter name matching one of the placeholders in the path | ||
*/ | ||
boolean: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "integer" type that's read from request path. | ||
* Usage: ` @param.path.integer('paramName')` | ||
* | ||
* @param name Parameter name matching one of the placeholders in the path | ||
*/ | ||
integer: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "long" type that's read from request path. | ||
* Usage: ` @param.path.long('paramName')` | ||
* | ||
* @param name Parameter name matching one of the placeholders in the path | ||
*/ | ||
long: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "float" type that's read from request path. | ||
* Usage: ` @param.path.float('paramName')` | ||
* | ||
* @param name Parameter name matching one of the placeholders in the path | ||
*/ | ||
float: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "double" type that's read from request path. | ||
* Usage: ` @param.path.double('paramName')` | ||
* | ||
* @param name Parameter name matching one of the placeholders in the path | ||
*/ | ||
double: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "byte" type that's read from request path. | ||
* Usage: ` @param.path.byte('paramName')` | ||
* | ||
* @param name Parameter name matching one of the placeholders in the path | ||
*/ | ||
byte: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "binary" type that's read from request path. | ||
* Usage: ` @param.path.binary('paramName')` | ||
* | ||
* @param name Parameter name matching one of the placeholders in the path | ||
*/ | ||
binary: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "date" type that's read from request path. | ||
* Usage: ` @param.path.date('paramName')` | ||
* | ||
* @param name Parameter name matching one of the placeholders in the path | ||
*/ | ||
date: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "dateTime" type that's read from request path. | ||
* Usage: ` @param.path.dateTime('paramName')` | ||
* | ||
* @param name Parameter name matching one of the placeholders in the path | ||
*/ | ||
dateTime: (name: string) => (target: Object, member: string, index: number) => void; | ||
/** | ||
* Define a parameter of "password" type that's read from request path. | ||
* Usage: ` @param.path.password('paramName')` | ||
* | ||
* @param name Parameter name matching one of the placeholders in the path | ||
*/ | ||
password: (name: string) => (target: Object, member: string, index: number) => void; | ||
}; | ||
@@ -102,3 +322,3 @@ /** | ||
*/ | ||
const array: (name: string, source: ParameterLocation, itemSpec: SchemaObject | ReferenceObject) => (target: Object, member: string | symbol, index: number) => void; | ||
const array: (name: string, source: ParameterLocation, itemSpec: SchemaObject | ReferenceObject) => (target: Object, member: string, index: number) => void; | ||
} |
@@ -63,3 +63,3 @@ import { RequestBodyObject, SchemaObject, ReferenceObject } from '@loopback/openapi-v3-types'; | ||
*/ | ||
export declare function requestBody(requestBodySpec?: Partial<RequestBodyObject>): (target: Object, member: string | symbol, index: number) => void; | ||
export declare function requestBody(requestBodySpec?: Partial<RequestBodyObject>): (target: Object, member: string, index: number) => void; | ||
export declare namespace requestBody { | ||
@@ -88,3 +88,3 @@ /** | ||
required?: boolean | undefined; | ||
} | undefined) => (target: Object, member: string | symbol, index: number) => void; | ||
} | undefined) => (target: Object, member: string, index: number) => void; | ||
} |
{ | ||
"name": "@loopback/openapi-v3", | ||
"version": "0.10.5", | ||
"version": "0.10.6", | ||
"description": "Processes openapi v3 related metadata", | ||
@@ -9,6 +9,6 @@ "engines": { | ||
"devDependencies": { | ||
"@loopback/build": "^0.6.5", | ||
"@loopback/openapi-spec-builder": "^0.7.4", | ||
"@loopback/repository": "^0.10.4", | ||
"@loopback/testlab": "^0.10.4", | ||
"@loopback/build": "^0.6.6", | ||
"@loopback/openapi-spec-builder": "^0.7.5", | ||
"@loopback/repository": "^0.11.0", | ||
"@loopback/testlab": "^0.10.5", | ||
"@types/debug": "0.0.30", | ||
@@ -55,6 +55,6 @@ "@types/lodash": "^4.14.106", | ||
"dependencies": { | ||
"@loopback/context": "^0.11.2", | ||
"@loopback/dist-util": "^0.3.1", | ||
"@loopback/openapi-v3-types": "^0.7.4", | ||
"@loopback/repository-json-schema": "^0.9.5", | ||
"@loopback/context": "^0.11.3", | ||
"@loopback/dist-util": "^0.3.2", | ||
"@loopback/openapi-v3-types": "^0.7.5", | ||
"@loopback/repository-json-schema": "^0.9.6", | ||
"debug": "^3.1.0", | ||
@@ -61,0 +61,0 @@ "lodash": "^4.17.5" |
@@ -34,3 +34,3 @@ // Copyright IBM Corp. 2018. All Rights Reserved. | ||
export function param(paramSpec: ParameterObject) { | ||
return function(target: Object, member: string | symbol, index: number) { | ||
return function(target: Object, member: string, index: number) { | ||
paramSpec = paramSpec || {}; | ||
@@ -37,0 +37,0 @@ // Get the design time method parameter metadata |
@@ -81,3 +81,3 @@ // Copyright IBM Corp. 2018. All Rights Reserved. | ||
export function requestBody(requestBodySpec?: Partial<RequestBodyObject>) { | ||
return function(target: Object, member: string | symbol, index: number) { | ||
return function(target: Object, member: string, index: number) { | ||
// Use 'application/json' as default content if `requestBody` is undefined | ||
@@ -84,0 +84,0 @@ requestBodySpec = requestBodySpec || {content: {}}; |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
New author
Supply chain riskA new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.
Found 1 instance in 1 package
203484
4168
0