OpenAPITools / OpenAPITools/openapi-generator

[BUG][typescript-axios] Generated JavaScript Sets are not serialized/deserialized

Open
#11,746 17 comments 14 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

The following schema generates a JavaScript Set property:

{
  "Test": {
    "required": [
      "a"
    ],
    "type": "object",
    "properties": {
      "a": {
        "uniqueItems": true,
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    }
  }
}

Generated object:

export interface Test {
    /**
     * 
     * @type {Set<string>}
     * @memberof Test
     */
    'a': Set<string>;
}

However when sending this request to the server, the value is not de-serialized as an array but just replaced with an empty object ("a":{}).

Similarly, when inspecting the returned data from an API, the actual values on the JavaScript object are not wrapped in a set, but return as an array.

openapi-generator version

4.5.0

Suggest a fix

Either don't generate Set and use a T[] or add conversions for sending and receiving sets

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

Reproduce the reported schema with the typescript-axios generator, then inspect the generated Test property and the request/response serialization paths. Done means Set values serialize as arrays and response arrays are wrapped as sets, or the generator consistently emits string arrays instead.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, openapi, typescript
Domain
api, tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.