RicoSuter/NSwag

typeof(void) still produces a response type of ProblemDetails

Open

#2861 opened on May 30, 2020

View on GitHub
 (6 comments) (9 reactions) (0 assignees)C# (6,291 stars) (1,189 forks)batch import
help wantedproject: NSwag.SwaggerGeneration.AspNetCore

Description

According to wiki "To define an operation without a response (i.e. HTTP 204 or 404), use the SwaggerResponseAttribute attribute and typeof(void)". Also according to wiki "SwaggerResponseAttribute(httpAction, type) (not recommended/deprecated, use ASP.NET Core's ProducesResponseTypeAttribute instead)".

So, I use this:

[ProducesResponseType(typeof(void), 404)]

Expected: 404 should have no response body.

Actual:

"404": {
            "description": "Blah blah.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          }

Contributor guide

Tech stack
csharp
Domain
backendapi
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
C#ASP.NET CoreNSwag basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
Investigate how NSwag resolves response types for void in ProducesResponseTypeAttribute. Look at the SwaggerResponseAttribute or the operation processor that generates response schemas. Check issue comments for any proposed fixes or workarounds. Consider if the fix involves modifying the response schema generation to skip schema for void types.