RicoSuter/NSwag

[nswag, v12.0.0] SwaggerToTypeScriptClientGenerator ignores the "readOnly" flag for properties

Open

#1,763 建立於 2018年11月22日

在 GitHub 查看
 (14 留言) (0 反應) (0 負責人)C# (6,291 star) (1,189 fork)batch import
help wantedproject: NJsonSchema.CodeGeneration.TypeScripttype: question

描述

The TypeScript code generated by nswag does not add the readonly TypeScript modifier for properties that has readOnly set to true in the Swagger specification file.

According to the Class.liquid template the modifier is added if property.IsReadOnly is true. I tried to debug using a custom template and property.IsReadOnly is set to false even for read-only properties.

I have observed this behavior for quite some time now and initially thought this could be by design. However, it seems to me that this is actually a bug.

貢獻者指南

技術棧
typescriptcsharp
領域
backendapi
議題類型
bug
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
C# basicsTypeScriptfamiliarity with NSwag templates
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
40
研究方向
Investigate the Class.liquid template and the property.IsReadOnly flag in the NSwag codebase. Look for how the Swagger specification's readOnly attribute is parsed and mapped to the property model. Check the OpenApiDocument or similar classes for correct handling of readOnly. Review recent commits or linked issues for any changes. Possibly add a test case to verify.