OpenAPITools / OpenAPITools/openapi-generator

[BUG] [TypeScript Axios] Generator claims to support Date/DateTime but doesn't

Open
#13,188 0 comments 9 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue: Bug
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Bug Report Checklist
  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator (example)?
  • Have you tested with the latest master to confirm the issue still exists?
  • Have you searched for related issues/PRs?
  • What's the actual output vs expected output?
  • [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description

I used the TypeScript Axios generator, which claims to support Date/DateTime. Looking at the generated code it's clearly it does not. It does no transformation of the data returned from the server over what Axios does so date time string don't get converted to Date objects.

openapi-generator version

6.0.1. Doesn't seem to be a regression.

OpenAPI declaration file content or url

Propertriatary but here's a sample of a date time field:

      "Channel": {
        "description": "A channel with project data.",
        "properties": {
          "created_at": {
            "format": "date-time",
            "title": "Created At",
            "type": "string"
          },
          "id": {
            "title": "Id",
            "type": "string"
          },
        },
        "required": [
          "created_at",
          "id",
        ],
        "title": "Channel",
        "type": "object"
      },
Generation Details
openapi-generator-cli generate -i ../backend/openapi.json -g typescript-axios -o ./generated/axios -c openapi-typescript-axios.config.json

The config just contains:

{
    "modelPropertyNaming": "original"
}
Steps to reproduce

Use the generator with a date-time field.

Related issues/PRs
Suggest a fix

Add the right transformations to the data returned by Axios.

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 with the TypeScript Axios generator and reproduce the issue using the provided OpenAPI schema and openapi-generator-cli command. Trace how date-time response fields are handled in the generated client. Done means generated clients convert date-time response strings into Date objects as the generator documentation claims.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.