RicoSuter/NSwag

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

Open

#3,398 建立於 2021年4月7日

在 GitHub 查看
 (3 留言) (0 反應) (0 負責人)C# (6,291 star) (1,189 fork)batch import
help wantedproject: NSwag.CodeGeneration.CSharp (Clients)

描述

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?

貢獻者指南

技術棧
csharp
領域
tooling
議題類型
bug
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
C# knowledgefamiliarity with NSwag codebase
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
65
研究方向
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.