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 ouverte le 7 avr. 2021

Voir sur GitHub
 (3 commentaires) (0 réactions) (0 assignés)C# (1 189 forks)batch import
help wantedproject: NSwag.CodeGeneration.CSharp (Clients)

Métriques du dépôt

Stars
 (6 291 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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?

Guide contributeur

Direction de recherche
Examinez la génération des noms de méthodes dans NSwag, en particulier dans des fichiers comme NamingUtilities.cs ou ClientGenerator. Le problème décrit des caractères non valides ($, ?, =) dans les noms de méthodes C#. Recherchez où les operationId et les segments de chemin sont assainis. La correction impliquerait d'ajouter ces caractères à la liste des caractères à supprimer ou à remplacer. Vérifiez s'il existe des tests existants pour la génération de noms de méthodes qui doivent être mis à jour.
Stack technique
csharp
Domaine
tooling
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
C# knowledgefamiliarity with NSwag codebase
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65