RicoSuter/NSwag

typeof(void) still produces a response type of ProblemDetails

Open

#2 861 ouverte le 30 mai 2020

Voir sur GitHub
 (6 commentaires) (9 réactions) (0 assignés)C# (1 189 forks)batch import
help wantedproject: NSwag.SwaggerGeneration.AspNetCore

Métriques du dépôt

Stars
 (6 291 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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"
                }
              }
            }
          }

Guide contributeur

Direction de recherche
Étudiez comment NSwag résout les types de réponse pour void dans ProducesResponseTypeAttribute. Examinez SwaggerResponseAttribute ou le processeur d'opération qui génère les schémas de réponse. Vérifiez les commentaires de l'issue pour toute correction proposée ou solution de contournement. Considérez si la correction implique de modifier la génération du schéma de réponse pour ignorer le schéma pour les types void.
Stack technique
csharp
Domaine
backendapi
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
C#ASP.NET CoreNSwag basics
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
45