UNPKG

@loopback/docs

Version:

Documentation files rendered at [https://loopback.io](https://loopback.io)

121 lines (60 loc) 1.79 kB
--- lang: en title: 'API docs: openapi-v3.param' keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI sidebar: lb4_sidebar editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/openapi-v3 permalink: /doc/en/lb4/apidocs.openapi-v3.param.html --- <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@loopback/openapi-v3](./openapi-v3.md) &gt; [param](./openapi-v3.param.md) ## param namespace Namespace for `@param.*` decorators **Signature:** ```typescript export declare namespace param ``` ## Functions <table><thead><tr><th> Function </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> [array(name, source, itemSpec)](./openapi-v3.param.array.md) </td><td markdown="1"> Define a parameter of `array` type. </td></tr> <tr><td markdown="1"> [filter(modelCtor, options)](./openapi-v3.param.filter.md) </td><td markdown="1"> Sugar decorator for `filter` query parameter </td></tr> <tr><td markdown="1"> [where(modelCtor, name)](./openapi-v3.param.where.md) </td><td markdown="1"> Sugar decorator for `where` query parameter </td></tr> </tbody></table> ## Variables <table><thead><tr><th> Variable </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> [header](./openapi-v3.param.header.md) </td><td markdown="1"> Header parameter decorator </td></tr> <tr><td markdown="1"> [path](./openapi-v3.param.path.md) </td><td markdown="1"> Path parameter decorator </td></tr> <tr><td markdown="1"> [query](./openapi-v3.param.query.md) </td><td markdown="1"> Query parameter decorator </td></tr> </tbody></table>