RicoSuter/NSwag

required field on response header spec not parsed correctly

Open

#2.928 geöffnet am 29. Juni 2020

Auf GitHub ansehen
 (1 Kommentar) (1 Reaktion) (0 zugewiesene Personen)C# (1.189 Forks)batch import
help wantedproject: NSwag.Core.Yamltype: bug

Repository-Metriken

Stars
 (6.291 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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)

Contributor Guide

Research-Richtung
Das Problem meldet, dass das Feld 'required' in OpenAPI Antwortheadern als String Array geparst wird, obwohl es ein Boolean sein sollte. Dies tritt in der NSwag Codegenerierung für C# auf. Schauen Sie sich an, wie das Feld 'required' für Pfadparameter zur Konsistenz behandelt wird. Der relevante Code befindet sich wahrscheinlich in der Deserialisierungslogik für OpenAPI Antwortheader. Ein guter Ausgangspunkt ist die Suche danach, wie 'required' in den Schemamodellen deserialisiert wird.
Tech Stack
csharp
Domain
backendtooling
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
basic C# knowledgefamiliarity with JSON serialization
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60