swagger-api/swagger-codegen

[Typescript-Fetch] Support for default params

Open

#3,641 opened on Aug 25, 2016

View on GitHub
 (6 comments) (0 reactions) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Client: TypeScriptEnhancement: Featurehelp wanted

Description

Description

Typescript-Fetch does not currently generate any code to help with default parameters in methods, but Typescript and ES6 have support for default parameters.

Implementing default parameters can help improve the usability of generated specs.

Swagger-codegen version

2.2.1

Swagger declaration file content or url
Command line used for generation
Steps to reproduce
Related issues
Suggest a Fix

It appears that the defaultValue helper exists to help solve this problem.

{{#defaultValue}}[default to {{defaultValue}}]{{/defaultValue}}

Contributor guide

Tech stack
typescriptrest api
Domain
apideveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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
swagger codegen internalsMustache templatesTypeScriptdefault parameters concept
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Examine the defaultValue helper usage in other language generators (e.g., Java, C#) to understand how default values are rendered. Then locate the typescript fetch template files (likely in modules/swagger codegen/src/main/resources/typescript fetch/) and modify the relevant template to include a default value when present. Ensure the generated TypeScript code uses ES6 default parameter syntax. Test with a sample spec containing default parameters.