@loopback/docs/site/apidocs/openapi-spec-builder.openapispecbuilder.withoperationreturningstring.md

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

---
lang: en
title: 'API docs: openapi-spec-builder.openapispecbuilder.withoperationreturningstring'
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.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.

**Signature:**

```typescript
withOperationReturningString(verb: string, path: string, operationName?: string): 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">

operationName


</td><td markdown="1">

string


</td><td markdown="1">

_(Optional)_ The name of the controller method implementing this operation (`x-operation-name` field).


</td></tr>
</tbody></table>

**Returns:**

this