OpenAPITools / OpenAPITools/openapi-generator

[BUG][typescript-fetch] generator does not map Java Date object to string

Open
#3,538 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Client: TypeScript
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Description

I'm unable to generate proper typescript code, because the generator does not convert swagger Date definitions into string, even though I've explictly used the type-mappings argument.

openapi-generator version

4.0.3

Command line used for generation
java -jar ${openApiGenCliJarDownloadDir} generate 
     -i http://myexample/v2/api-docs 
     -g typescript-fetch 
     -o src/api/myexample/generated-client-open-api 
     --type-mappings=Date=string  
     --additional-properties modelPropertyNaming=original 
Result
export interface MyInterface {
    /**
     * date of birth in YYYY-MM-DD format
     * @type {Date}
     * @memberof MyInterface
     */
    date_of_birth?: Date;
    /**
     * decease date in YYYY-MM-DD format
     * @type {Date}
     * @memberof MyInterface
     */
    decease_date?: Date;
    /**
}

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the reported Java CLI command with the typescript-fetch generator and inspect the generator's handling of Date definitions and type mappings. Done means the generated interface uses string rather than Date for the reported date fields when --type-mappings=Date=string is supplied.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, typescript
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.