RicoSuter/NSwag

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

Open

#2,885 opened on Jun 10, 2020

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

Repository metrics

Stars
 (6,291 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Inspect the C# client code generation code in NSwag, specifically how it processes OpenAPI media type objects that have an example but no schema. Identify where the exception is thrown and determine if a missing schema check is needed.
Tech stack
csharp
Domain
apibackend
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
OpenAPISwaggerNSwag
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60