UNPKG

@loopback/docs

Version:

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

97 lines (48 loc) 1.64 kB
--- lang: en title: 'API docs: openapi-spec-builder.openapispecbuilder.withoperation' keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI sidebar: lb4_sidebar editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/openapi-spec-builder permalink: /doc/en/lb4/apidocs.openapi-spec-builder.openapispecbuilder.withoperation.html --- <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@loopback/openapi-spec-builder](./openapi-spec-builder.md) &gt; [OpenApiSpecBuilder](./openapi-spec-builder.openapispecbuilder.md) &gt; [withOperation](./openapi-spec-builder.openapispecbuilder.withoperation.md) ## OpenApiSpecBuilder.withOperation() method Define a new OperationObject at the given path and verb (method). **Signature:** ```typescript withOperation(verb: string, path: string, spec: OperationObject | OperationSpecBuilder): this; ``` ## Parameters <table><thead><tr><th> Parameter </th><th> Type </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> verb </td><td markdown="1"> string </td><td markdown="1"> The HTTP verb. </td></tr> <tr><td markdown="1"> path </td><td markdown="1"> string </td><td markdown="1"> The path relative to basePath. </td></tr> <tr><td markdown="1"> spec </td><td markdown="1"> OperationObject \| [OperationSpecBuilder](./openapi-spec-builder.operationspecbuilder.md) </td><td markdown="1"> Additional specification of the operation. </td></tr> </tbody></table> **Returns:** this