required field on response header spec not parsed correctly · RicoSuter/NSwag#2928

(1 comment) (1 reaction) (0 assignees)C# (6,291 stars) (1,189 forks)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
Issue 種別: bug
難度: 2
推定時間: under 1 hour
活動状況: stale
明確さ: clear
前提条件: basic C# knowledgefamiliarity with JSON serialization
初心者向け度: 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.