RicoSuter/NSwag

typeof(void) still produces a response type of ProblemDetails

Open

#2,861 opened on May 30, 2020

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

Repository metrics

Stars
 (6,291 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Inspect how NSwag processes the ProducesResponseType attribute with typeof(void) and trace why it still generates a ProblemDetails schema instead of omitting the response body. Check the response schema generation logic in the ASP.NET Core to OpenAPI conversion.
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.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C#ASP.NET Core
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70