RicoSuter/NSwag

required field on response header spec not parsed correctly

Open

#2,928 建立於 2020年6月29日

在 GitHub 查看
 (1 留言) (1 反應) (0 負責人)C# (6,291 star) (1,189 fork)batch import
help wantedproject: NSwag.Core.Yamltype: bug

描述

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)

貢獻者指南

技術棧
csharp
領域
backendtooling
議題類型
bug
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
basic C# knowledgefamiliarity with JSON serialization
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60
研究方向
The issue reports that the 'required' field in OpenAPI response headers is being parsed as a string array when it should be a boolean. This occurs in the NSwag code generation for C#. Look at how the path parameter 'required' field is handled for consistency. The relevant code is likely in the deserialization logic for OpenAPI response headers. A good starting point is to search for how 'required' is deserialized in the schema models.