RicoSuter/NSwag

Bug - NSwag generates bad code for an enum

Open

#2883 opened on Jun 9, 2020

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

Description

I have 2 DTOs, both contain same Enum image

I have 2 controller methods using those DTO as URL query args image

I have 2 swagger definitions with same Enum image

And I get bad code from NSwag with "2" added to Enum name image

If this is not a bug then what am I doing wrong? Also this seem to be wrong only on method signature of the generated interface and the class, once I remove "2" the code compiles and I think it's generally ok code

image

Contributor guide

Tech stack
csharptypescript
Domain
toolingapi
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Understanding of NSwagBasic knowledge of C# and TypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
Investigate how NSwag handles enum naming when the same enum appears in multiple DTOs. Look at the TypeScript client generation code in the NSwag repository, specifically the part that assigns names to enums. The issue shows that an enum gets a '2' suffix, likely due to a naming conflict resolution. Check if there is a collision detection mechanism and why it fails. Also review the two comments on the issue for any additional insights. Consider reproducing the issue with a minimal example to confirm the behavior.