Skip to content

Releases: openapi-ts/openapi-typescript

v6.0.2

10 Nov 02:46
Compare
Choose a tag to compare

🐛 Bugfixes

  • Fixes #975 where #/components/examples were being parsed as schema objects

v6.0.1

09 Nov 04:37
Compare
Choose a tag to compare

🐛 Bugfixes

  • Remove postinstall hook only meant for dev

v6.0.0

09 Nov 04:11
903fd34
Compare
Choose a tag to compare

New Features

  • OpenAPI 3.1 support for discriminator and polymorphic types
  • New transform() and postTransform() hooks give you more control in overriding/extending generated types
  • Deep-linked remote schemas now work
  • --immutable-types has a new -t alias
  • Addition of path.default types

🚀 Improvements

  • Sped up type generation by ~3× by dropping Prettier & optimizing deep-object crawl speed
  • More accurate types for oneOf / anyOf / allOf (#894)
  • Now ships modern ESNext code rather than ES2018
  • Codebase cleanup; improved internal types & documentation
  • Test cleanup, now powered by Vitest

🐛 Bugfixes

🔨 Breaking Changes

  • Dropped Prettier formatting and all formatting options. Now, simply format at your discretion (or not at all!)
  • Dropped support for Swagger 2.0
  • Dropped Node 14 support (it still works for now, but Node 14 bugs won’t be fixed if any arise)
  • --version was changed to return the version of this library (also by dropping Swagger 2.0 support the old usage was no longer needed)
  • Dropped --raw-schema. Your entry schema MUST be valid and complete (however, your $refs to subschemas may be partials).
  • Dropped --make-paths-enum because it was incompatible with --path-params-as-types
  • Dropped the CLI aliases -it and -ap (specify the full --immutable-types or --additional-properties flag)
  • Empty content: {} now returns never. Dropped the --content-never flag as this is now the default behavior.
  • Renamed and upgraded the Node API’s formatter() function to transform() and postTransform(). It’s an overall improvement on the original concept with even more power than before.

v5.4.0

02 Jun 03:36
Compare
Choose a tag to compare

New features

🐛 Bugfixes

v5.3.0

02 May 19:12
Compare
Choose a tag to compare

New features

  • New --make-paths-enum CLI flag by @berzi (#883)
  • New --path-params-as-types CLI flag by @Powell-v2 (#891)
  • Supports /** @constant */ JSDoc comments by @PhilipTrauner (#896)
  • You can now add your own custom comment header at the top of every generated doc (#904)

🐛 Bugfixes

  • Fixes inconsistent comment title (#904)

v5.2.0

13 Feb 06:31
Compare
Choose a tag to compare

New features

🐛 Bugfixes

  • Fixes CommonJS error for undici on older versions of Node

🐣 Minor changes

  • Tiny optimizations for a little speed boost
  • Updated schemas & examples

v5.1.1

24 Jan 02:47
Compare
Choose a tag to compare

⚠️ Changes

  • Removes CJS version from npm (to use CJS, use openapi-typescript@4). Version 5 switched to ESM as default anyway, and since tests are now testing ESM, the reliability of CJS was dubious (and there were TypeScript problems as well)

🐛 Bugfixes

v5.1.0

11 Jan 01:34
Compare
Choose a tag to compare

New Features

🐛 Bugfixes

v5.0.1

11 Jan 01:20
Compare
Choose a tag to compare

🐛 Bugfixes

  • Adds missing types for CJS build (#861)

v5.0.0

27 Dec 02:53
Compare
Choose a tag to compare

🦍 Major changes

  • Updates this library to full ESM! ✨ This is the future of JavaScript, and is now natively supported in Node 14+.

🐥 Minor changes

  • Now supports a URL() as input to make ESM usage easier (see example)

⚠️ Breaking changes

  • 5.x drops support for Node 12. If you’re still on Node 12, be sure to lock your version to 4.x.