RicoSuter/NSwag

need to remove/replace some more characters that are invalid for C# method names when using operationId and path segments

Open

#3398 opened on Apr 7, 2021

View on GitHub
 (3 comments) (0 reactions) (0 assignees)C# (6,291 stars) (1,189 forks)batch import
help wantedproject: NSwag.CodeGeneration.CSharp (Clients)

Description

I have a swagger 2.0 file that uses a query parameter in the path and has an operationId that contains a $

This is hitting VMware's vCenter

    "/rest/vcenter/vcha/cluster/mode?vmw-task=true": {
        "put": {
            [... extra deleted ...]
            "operationId": "set$task"
        }
    },

when using SingleClientFromPathSegments, the method name generated is "RestVcenterVchaClusterMode?vmwTask=trueAsync" which is invalid (? and = need to be removed or replaced AFAICT?)

when using SingleClientFromOperationId, the method name generated is "Set$taskAsync" which is invalid ($ needs to be removed or replaced AFAICT?)

Hopefully filtering out characters that are invalid C# would do the trick?

Contributor guide

Tech stack
csharp
Domain
tooling
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
C# knowledgefamiliarity with NSwag codebase
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Investigate the method name generation in NSwag, particularly in files like NamingUtilities.cs or ClientGenerator. The issue describes invalid characters ($, ?, =) in C# method names. Look for where operationId and path segments are sanitized. The fix would involve adding those characters to the list of removed or replaced characters. Check if there are any existing tests for method name generation that need updating.