RicoSuter/NSwag

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

Open

#2885 opened on Jun 10, 2020

View on GitHub
 (1 comment) (0 reactions) (0 assignees)C# (6,291 stars) (1,189 forks)batch import
help wantedtype: bug

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

Contributor guide

Tech stack
csharp
Domain
api
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# knowledgeUnderstanding of OpenAPINSwag basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Investigate the NSwag code generation logic that handles example nodes in content types without a schema. Look in the NJsonSchema or codegen source for where the schema property is accessed and ensure it is null checked. Use the attached sample api.txt to reproduce the exception and identify the exact location. Consider adding a fallback or validation when schema is missing.