Skip to content

Commit 778899f

Browse files
committed
docs: update cli plugin documentation
1 parent c838bb9 commit 778899f

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

content/openapi/cli-plugin.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,8 @@ You can use the `options` property to customize the behavior of the plugin.
153153
"name": "@nestjs/swagger",
154154
"options": {
155155
"classValidatorShim": false,
156-
"introspectComments": true
156+
"introspectComments": true,
157+
"skipAutoHttpCode": true
157158
}
158159
}
159160
]
@@ -171,6 +172,7 @@ export interface PluginOptions {
171172
dtoKeyOfComment?: string;
172173
controllerKeyOfComment?: string;
173174
introspectComments?: boolean;
175+
skipAutoHttpCode?: boolean;
174176
}
175177
```
176178

@@ -210,6 +212,11 @@ export interface PluginOptions {
210212
<td><code>false</code></td>
211213
<td>If set to true, plugin will generate descriptions and example values for properties based on comments</td>
212214
</tr>
215+
<tr>
216+
<td><code>skipAutoHttpCode</code></td>
217+
<td><code>false</code></td>
218+
<td>Disables the automatic addition of <code>@HttpCode()</code> in controllers</td>
219+
</tr>
213220
</table>
214221

215222
Make sure to delete the `/dist` folder and rebuild your application whenever plugin options are updated.

0 commit comments

Comments
 (0)