RicoSuter/NSwag

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

Open

#1763 opened on Nov 22, 2018

View on GitHub
 (14 comments) (0 reactions) (0 assignees)C# (6,291 stars) (1,189 forks)batch import
help wantedproject: NJsonSchema.CodeGeneration.TypeScripttype: question

Description

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.

Contributor guide

Tech stack
typescriptcsharp
Domain
backendapi
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
C# basicsTypeScriptfamiliarity with NSwag templates
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
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.