This content is part of a third party extension that is not supported by the Cake project.
For more information about this extension see Cake.NSwag.
Summary
Sets the API description for use in the generated specification
- Assembly
- Cake
.NSwag .dll - Namespace
- Cake
.NSwag .Settings - Containing Type
- Swagger
Generator Settings Extensions
Syntax
public static SwaggerGeneratorSettings WithDescription(this SwaggerGeneratorSettings settings, string description)Parameters
| Name | Type | Description |
|---|---|---|
| settings | Swagger |
The settings |
| description | string | Description to include with the generated API spec |
Return Value
| Type | Description |
|---|---|
| Swagger |
The updated settings object |