RicoSuter/NSwag

required field on response header spec not parsed correctly

Open

#2928 aperta il 29 giu 2020

Vedi su GitHub
 (1 commento) (1 reazione) (0 assegnatari)C# (1189 fork)batch import
help wantedproject: NSwag.Core.Yamltype: bug

Metriche repository

Star
 (6291 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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)

Guida contributor

Direzione di ricerca
Il problema segnala che il campo 'required' negli header di risposta OpenAPI viene analizzato come un array di stringhe quando dovrebbe essere un booleano. Ciò si verifica nella generazione del codice C# di NSwag. Esamina come viene gestito il campo 'required' del parametro di percorso per coerenza. Il codice rilevante è probabilmente nella logica di deserializzazione per gli header di risposta OpenAPI. Un buon punto di partenza è cercare come 'required' viene deserializzato nei modelli di schema.
Tech stack
csharp
Dominio
backendtooling
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
basic C# knowledgefamiliarity with JSON serialization
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60