RicoSuter/NSwag

Make ExtensionData available in Typescript client generator templates

Open

#2947 opened on Jul 9, 2020

View on GitHub
 (4 comments) (5 reactions) (0 assignees)C# (6,291 stars) (1,189 forks)batch import
help wantedtype: enhancement

Description

Could you please make ExtensionData also available in NJsonSchema.CodeGeneration.TypeScript.Models.EnumTemplateModel (like NJsonSchema.CodeGeneration.CSharp.Models.EnumTemplateModel, see #1436)

I'm missing the following property (and its population):

public IDictionary<string, object> ExtensionData => _schema.ExtensionData;

I would like to access the {{ ExtensionData["x-enumDescriptions"] }} field in my custom liquid template.

Contributor guide

Tech stack
csharptypescript
Domain
tooling
Issue type
feature
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#NSwag code generation fundamentals
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Look at the referenced issue #1436 for the C# implementation. Find the file 'NJsonSchema.CodeGeneration.TypeScript.Models.EnumTemplateModel' in the NSwag repository. Add a property 'ExtensionData' similar to the C# model, ensuring it is populated from the schema's ExtensionData. Test with a custom liquid template using '{{ ExtensionData["x enumDescriptions"] }}'.