UNPKG

@loopback/docs

Version:
36 lines (23 loc) 1.24 kB
--- lang: en title: 'API docs: openapi-spec-builder.openapispecbuilder.withoperationreturningstring' keywords: LoopBack 4.0, LoopBack 4 sidebar: lb4_sidebar permalink: /doc/en/lb4/apidocs.openapi-spec-builder.openapispecbuilder.withoperationreturningstring.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; [withOperationReturningString](./openapi-spec-builder.openapispecbuilder.withoperationreturningstring.md) ## OpenApiSpecBuilder.withOperationReturningString() method Define a new operation that returns a string response. <b>Signature:</b> ```typescript withOperationReturningString(verb: string, path: string, operationName?: string): this; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | | verb | <code>string</code> | The HTTP verb. | | path | <code>string</code> | The path relative to basePath. | | operationName | <code>string</code> | The name of the controller method implementing this operation (<code>x-operation-name</code> field). | <b>Returns:</b> `this`