RicoSuter/NSwag

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

Open

#3398 aperta il 7 apr 2021

Vedi su GitHub
 (3 commenti) (0 reazioni) (0 assegnatari)C# (1189 fork)batch import
help wantedproject: NSwag.CodeGeneration.CSharp (Clients)

Metriche repository

Star
 (6291 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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?

Guida contributor

Direzione di ricerca
Indaga sulla generazione dei nomi dei metodi in NSwag, in particolare nei file come NamingUtilities.cs o ClientGenerator. Il problema descrive caratteri non validi ($, ?, =) nei nomi dei metodi C#. Cerca dove vengono sanificati operationId e i segmenti del percorso. La correzione comporterebbe l'aggiunta di quei caratteri all'elenco dei caratteri da rimuovere o sostituire. Verifica se esistono test per la generazione dei nomi dei metodi che necessitano di aggiornamento.
Tech stack
csharp
Dominio
tooling
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
C# knowledgefamiliarity with NSwag codebase
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65