RicoSuter/NSwag

Generated enum name collision

Open

#1,357 opened on May 30, 2018

View on GitHub
 (4 comments) (0 reactions) (0 assignees)C# (1,189 forks)batch import
help wantedproject: NJsonSchema.CodeGeneration.CSharptype: bug

Repository metrics

Stars
 (6,291 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

I have a schema which contains the following parameter:

          {
            "name": "sort",
            "type": "string",
            "enum": [
              "id",
              "-id",
              "add_date",
              "-add_date"
            ],
            "in": "query"
          },

The following code is generated, which does not compile due to the duplicate enums:

    public enum Sort
    {
        [System.Runtime.Serialization.EnumMember(Value = "id")]
        Id = 0,
    
        [System.Runtime.Serialization.EnumMember(Value = "-id")]
        Id = 1,
    
        [System.Runtime.Serialization.EnumMember(Value = "add_date")]
        Add_date = 2,
    
        [System.Runtime.Serialization.EnumMember(Value = "-add_date")]
        Add_date = 3,
    
    }

Generated with NSwagStudio 11.17.12.0

Contributor guide

Research direction
Investigate the enum name generation logic in NSwag to handle values with leading ' ' to avoid duplicate names.
Tech stack
csharp
Domain
backend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C#Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75