Releases: drwpow/openapi-typescript
openapi-fetch@0.9.7
Patch Changes
- #1672
64cb619Thanks @jaredLunde! - Fixes issue where native properties were not excluded from custom properties in the CustomRequest class
openapi-typescript@7.0.0-rc.0
openapi-typescript
7.0.0
Major Changes
-
6d1eb32Thanks @drwpow! -⚠️ Breaking: The Node.js API now returns the TypeScript AST for the main method as well astransform()andpostTransform(). To migrate, you’ll have to use thetypescriptcompiler API:+ import ts from "typescript"; + const DATE = ts.factory.createIdentifier("Date"); + const NULL = ts.factory.createLiteralTypeNode(ts.factory.createNull()); const ast = await openapiTS(mySchema, { transform(schemaObject, metadata) { if (schemaObject.format === "date-time") { - return schemaObject.nullable ? "Date | null" : "Date"; + return schemaObject.nullable + ? ts.factory.createUnionTypeNode([DATE, NULL]) + : DATE; } }, };
Though it’s more verbose, it’s also more powerful, as now you have access to additional properties of the generated code you didn’t before (such as injecting comments).
For example syntax, search this codebae to see how the TypeScript AST is used.
Also see AST Explorer’s
typescriptparser to inspect how TypeScript is interpreted as an AST. -
6d1eb32Thanks @drwpow! -⚠️ Breaking: Changing of several CLI flags and Node.js API options- The
--auth,--httpHeaders,--httpMethod, andfetch(Node.js-only) options were all removed from the CLI and Node.js API- To migrate, you’ll need to create a redocly.yaml config that specifies your auth options in the http setting
- You can also set your fetch client in redocly.yaml as well.
--immutable-typeshas been renamed to--immutable--support-array-lengthhas been renamed to--array-length
- The
-
fbaf96dThanks @drwpow! -⚠️ Breaking: Remove globbing schemas in favor ofredocly.yamlconfig. Specify multiple schemas with outputs in there instead. See Multiple schemas for more info. -
6d1eb32Thanks @drwpow! -⚠️ Breaking: Most optional objects are now always present in types, just typed as:never. This includes keys of the Components Object as well as HTTP methods. -
6d1eb32Thanks @drwpow! -⚠️ Breaking: No moreexternalexport in schemas anymore. Everything gets flattened into thecomponentsobject instead (if referencing a schema object from a remote partial, note it may have had a minor name change to avoid conflict). -
6d1eb32Thanks @drwpow! -⚠️ BreakingdefaultNonNullableoption now defaults totrue. You’ll now need to manually setfalseto return to old behavior. -
799194dThanks @drwpow~ -⚠️ Breaking TypeScript is now a peerDependency and must be installed alongsideopenapi-typescript
Minor Changes
-
6d1eb32Thanks @drwpow! - ✨ Feature: automatically validate schemas with Redocly CLI (docs). No more need for external tools to report errors! 🎉- By default, it will only throw on actual schema errors (uses Redocly’s default settings)
- For stricter linting or custom rules, you can create a redocly.yaml config
-
312b7baThanks @drwpow! - ✨ Feature: allow configuration of schemas viaapiskey in redocly.config.yaml. See docs for more info.- Any options passed into your redocly.yaml config are respected
-
6d1eb32Thanks @drwpow! - ✨ Feature: addenumoption to export top-level enums from schemas -
6d1eb32Thanks @drwpow! - ✨ Feature: addformatOptionsto allow formatting TS output -
6d1eb32Thanks @drwpow! - ✨ Feature: header responses add[key: string]: unknownindex type to allow for additional untyped headers -
6d1eb32Thanks @drwpow! - ✨ Feature: bundle schemas with Redocly CLI -
6d1eb32Thanks @drwpow! - ✨ Feature: Added debugger that lets you profile performance and see more in-depth messages -
#1374
7ac5174Thanks @ElForastero! - Add support for x-enum-varnames and x-enum-descriptions -
#1545
9158b81Thanks @jaredLunde! - Replace # characters in operation IDs with a slash
Patch Changes
-
6d1eb32Thanks @drwpow! - Refactor internals to use TypeScript AST rather than string mashing -
6d1eb32Thanks @drwpow! - 🧹 Cleaned up and reorganized all tests -
#1602
9da96cdThanks @JeanRemiDelteil! - Do not add readonly on Typescript enum when the --immutable option is used.
6.7.0
Minor Changes
6.6.2
Patch Changes
-
#1348
f6fdd2fThanks @drwpow! - Improve YAML vs JSON parsing -
#1345
6f078c1Thanks @SchabaJo! - Mirror directory structure of input files if output is a directory to prevent overwriting the same file again and again.
6.6.1
Patch Changes
6.6.0
Minor Changes
- #1335
7cb02acThanks @duncanbeevers! - Request parameters member is optional when all parameters are optional.
6.5.5
Patch Changes
6.5.4
Patch Changes
6.5.3
Patch Changes
- #1320 [
3cf78b9](3cf78b920ab23624c0524e0d5833...
openapi-fetch@0.9.6
openapi-fetch@0.9.5
openapi-fetch@0.9.4
Patch Changes
-
#1597
1f7ad9dThanks @armandabric! - Allow to select the response content type -
#1585
4e06f86Thanks @mikestopcontinues! - Update types for path-methods object -
#1610
cc8073bThanks @illright! - Fix data/error discrimination when there are empty-body errors
openapi-typescript@6.7.5
Patch Changes
-
#1535
48ca069fd889acd469955589ff3ec74e775ca9fdThanks @tvanier! - Support single operation parameter -
#1524
fe6c6d1526c59e4f9021d71cad74feba315f337fThanks @WickyNilliams! - Keep type information for nullable fields when possible
openapi-fetch@0.9.3
openapi-fetch@0.9.2
Patch Changes
- #1550
a5a9cc7Thanks @shirish87! - Fix 'Content-Type' header being removed from requests with multipart/form-data body