openapi-generator icon indicating copy to clipboard operation
openapi-generator copied to clipboard

Fix: Incorrect serialisation of maps and sets in typescript-axios without changing other object types

Open adrianhelvikspond opened this issue 5 months ago • 2 comments

This fixes the probles with #17790 by only changing object literals and null prototype objects.

This fixes #11746


This produces type definitions that aren't compatible with the typescript-axios client:

    someField:
      uniqueItems: true
      type: array
      items:
        type: string

My fix serialises of Sets into arrays and Maps into objects, since otherwise they are not serialized with JSON.stringify, see https://stackoverflow.com/questions/31190885/json-stringify-a-set


PR checklist

  • [x] Read the contribution guidelines.
  • [x] Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • [x] Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL) Commit all changed files. This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master. These must match the expectations made by your contribution. You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*. IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • [x] File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • [ ] If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • [ ] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

adrianhelvikspond avatar Sep 23 '25 10:09 adrianhelvikspond

please review the build failure when you've time

cc @TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @topce (2018/10) @akehir (2019/07) @petejohansonxo (2019/11) @amakhrov (2020/02) @davidgamero (2022/03) @mkusaka (2022/04) @joscha (2024/10)

wing328 avatar Oct 20 '25 03:10 wing328

Looks like an unrelated type error from what I can see. node_modules/@angular/core/discovery.d.d.ts(73,23): error TS2304: Cannot find name 'PromiseSettledResult'.

I've rebased off of the latest master now.

Edit: Had to change the typescript lib from es6 to es2020.

adrianhelvikspond avatar Dec 09 '25 11:12 adrianhelvikspond