RicoSuter/NSwag

C# Controller Code Does Not Compile When Operation Id Has Underscore Followed By Digit

Open

#2,192 opened on May 27, 2019

View on GitHub
 (3 comments) (0 reactions) (0 assignees)C# (1,189 forks)batch import
help wantedproject: NSwag.CodeGenerationtype: enhancement

Repository metrics

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

Description

The C# controller code generated for the definition below, fails to compile, with the following error message: Error CS1519: Invalid token '1' in class, struct, or interface member declaration

{ "openapi": "3.0.1", "info": { "title": "OperationId with an underscore followed by a digit", "version": "v1" }, "paths": { "/gettext": { "get": { "operationId": "gettext_1", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } }, "x-annotation-nullable": true } } } } } }

Contributor guide

Research direction
Examine how NSwag generates controller method names from operationId. The underscore followed by a digit (e.g., 'gettext 1') breaks codegen because the digit cannot start an identifier in C#. Check the code that formats the operationId into a method name, likely in a helper that sanitizes or transforms the string. Look for issues with leading underscores or digits after underscores.
Tech stack
csharp
Domain
backendtooling
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C#NSwag basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70