RicoSuter/NSwag

Angular typescript client generation support for DeepObject

Open

#1665 opened on Oct 12, 2018

View on GitHub
 (2 comments) (0 reactions) (0 assignees)C# (6,291 stars) (1,189 forks)batch import
help wantedproject: NSwag.CodeGeneration.TypeScripttype: bug

Description

I think the section from /src/NSwag.CodeGeneration.CSharp/Templates/Client.Class.QueryParameter.liquid

{% elseif parameter.IsDeepObject -%}

must also be added to the typescript version in /src/NSwag.CodeGeneration.TypeScript/Templates/Client.RequestUrl.liquid for correct DeepObject suppor.

Contributor guide

Tech stack
typescriptcsharpangular
Domain
apibackend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
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
Familiarity with NSwagTypeScript template syntaxDeepObject parameter handling
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Examine the C# template at /src/NSwag.CodeGeneration.CSharp/Templates/Client.Class.QueryParameter.liquid for the DeepObject conditional block. Then add similar logic to the TypeScript template at /src/NSwag.CodeGeneration.TypeScript/Templates/Client.RequestUrl.liquid. Ensure the generated TypeScript code correctly serializes deep object parameters. Review the existing tests for other parameter styles to see if new tests are needed.