RicoSuter/NSwag

required field on response header spec not parsed correctly

Open

#2 928 ouverte le 29 juin 2020

Voir sur GitHub
 (1 commentaire) (1 réaction) (0 assignés)C# (1 189 forks)batch import
help wantedproject: NSwag.Core.Yamltype: bug

Métriques du dépôt

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

Description

The following response header YAML definition gives an error while generating C# Core 3.1 code:

  responses:
    '200':
      description: OK
      headers:
        Last-Modified:
          description: The UTC datetime at when the item was last modified
          required: true
          schema:
            type: string

Exception: Newtonsoft.Json.JsonSerializationException: Error converting value "true" to type 'System.Collections.Generic.ICollection1[System.String]'. Path 'paths['/item/{id}'].head.responses.200.headers.Last-Modified.required', line 1, position 2518. ---> System.ArgumentException: Could not cast or convert from System.String to System.Collections.Generic.ICollection1[System.String].

It looks like the generator is expecting a string array, while the required parameter should be parsed as a boolean, just like path parameters

(version 13.6.2)

Guide contributeur

Direction de recherche
Le problème signale que le champ 'required' dans les en têtes de réponse OpenAPI est analysé comme un tableau de chaînes alors qu'il devrait être un booléen. Cela se produit dans la génération de code C# de NSwag. Examinez comment le champ 'required' du paramètre de chemin est traité pour assurer la cohérence. Le code pertinent se trouve probablement dans la logique de désérialisation pour les en têtes de réponse OpenAPI. Un bon point de départ est de rechercher comment 'required' est désérialisé dans les modèles de schéma.
Stack technique
csharp
Domaine
backendtooling
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.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
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
basic C# knowledgefamiliarity with JSON serialization
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60