RicoSuter/NSwag

Exception occurring during c# client generation using any code generation method

Open

#2 885 ouverte le 10 juin 2020

Voir sur GitHub
 (1 commentaire) (0 réactions) (0 assignés)C# (1 189 forks)batch import
help wantedtype: bug

Métriques du dépôt

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

Description

While generating the c# client for an api an exception occurs. I isolated the smallest section of the API that fails and it can bee seen in the attached "sample-api.txt" file (json) The issue appears related to having an example node under the content type section (application/json) without having an schema node. That particular scenario is not flagged as an error is Swagger and the documentation does not point to schema being a mandatory node. sample-api.txt

Guide contributeur

Direction de recherche
Étudiez la logique de génération de code NSwag qui traite les nœuds d'exemple dans les types de contenu sans schéma. Cherchez dans le code source de NJsonSchema ou de la génération de code où la propriété schema est accédée et assurez vous qu'elle est vérifiée pour null. Utilisez le fichier sample api.txt joint pour reproduire l'exception et identifier l'emplacement exact. Envisagez d'ajouter une solution de repli ou une validation lorsque le schéma est manquant.
Stack technique
csharp
Domaine
api
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# knowledgeUnderstanding of OpenAPINSwag basics
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60