Patch Changes

• #1784 c2f8655 Thanks @yoshi2no! - Fix: Correct handling of identical minItems and maxItems in array schemas when arrayLength option is true

Minor Changes

• #1766 0ce35d7 Thanks @phk422! - feat: Add the inject option

• #1768 285b097 Thanks @phk422! - feat: Add check option

Patch Changes

• #1772 41cb9a2 Thanks @ashwin153! - fix: add explicit import of performance to fix bazel compatibility issues

• #1764 2793049 Thanks @michalfedyna! - Fix --properties-required-by-default flag not working

• #1763 19b9383 Thanks @nkt! - fix: schema.content might be omitted

Patch Changes

• #1746 e705909 Thanks @phk422! - fix: Correct handling of default parameter values in referenced component schema

Patch Changes

• #1761 8043c5d Thanks @yoshi2no! - fix: Enum option cannot generate enums if values are not valid property names

Patch Changes

• #1743 8f6ec20 Thanks @avaly! - Generate valid types for referenced nested properties

Patch Changes

• #1724 f47268f Thanks @simensol! - Make sure result is an object before using the in operator.

Patch Changes

• #1696 aea31a8 Thanks @swachter! - Fix: encode primitive path parameters

Patch Changes

• #1719 a8f2253 Thanks @drwpow! - Remove nanoid from dependencies

• #1719 a8f2253 Thanks @drwpow! - Fix "failed to execute fetch on Window" error

• #1719 a8f2253 Thanks @drwpow! - Revert customFetch API back to fetch(input: Request)

Major Changes

• 6d1eb32 Thanks @drwpow! - ⚠️ Breaking: The Node.js API now returns the TypeScript AST for the main method as well as transform() and postTransform(). To migrate, you’ll have to use the typescript compiler 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 typescript parser to inspect how TypeScript is interpreted as an AST.

• 6d1eb32 Thanks @drwpow! - ⚠️ Breaking: Changing of several CLI flags and Node.js API options

  • The --auth, --httpHeaders, --httpMethod, and fetch (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-types has been renamed to --immutable
  • --support-array-length has been renamed to --array-length

• fbaf96d Thanks @drwpow! - ⚠️ Breaking: Remove globbing schemas in favor of redocly.yaml config. Specify multiple schemas with outputs in there instead. See Multiple schemas for more info.

• 6d1eb32 Thanks @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.

• 6d1eb32 Thanks @drwpow! - ⚠️ Breaking: No more external export in schemas anymore. Everything gets flattened into the components object instead (if referencing a schema object from a remote partial, note it may have had a minor name change to avoid conflict).

• 6d1eb32 Thanks @drwpow! - ⚠️ Breaking defaultNonNullable option now defaults to true. You’ll now need to manually set false to return to old behavior.

• 799194d Thanks @drwpow~ - ⚠️ Breaking TypeScript is now a peerDependency and must be installed alongside openapi-typescript

Minor Changes

• 6d1eb32 Thanks @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

• 312b7ba Thanks @drwpow! - ✨ Feature: allow configuration of schemas via apis key in redocly.config.yaml. See docs for more info.

  • Any options passed into your redocly.yaml config are respected

• 6d1eb32 Thanks @drwpow! - ✨ Feature: add enum option to export top-level enums from schemas

• 6d1eb32 Thanks @drwpow! - ✨ Feature: add formatOptions to allow formatting TS output

• 6d1eb32 Thanks @drwpow! - ✨ Feature: header responses add [key: string]: unknown index type to allow for additional untyped headers

• 6d1eb32 Thanks @drwpow! - ✨ Feature: bundle schemas with Redocly CLI

• 6d1eb32 Thanks @drwpow! - ✨ Feature: Added debugger that lets you profile performance and see more in-depth messages

• #1374 7ac5174 Thanks @ElForastero! - Add support for x-enum-varnames and x-enum-descriptions

• #1545 9158b81 Thanks @jaredLunde! - Replace # characters in operation IDs with a slash

Patch Changes

• 6d1eb32 Thanks @drwpow! - Refactor internals to use TypeScript AST rather than string mashing

• 6d1eb32 Thanks @drwpow! - 🧹 Cleaned up and reorganized all tests

• #1602 9da96cd Thanks @JeanRemiDelteil! - Do not add readonly on Typescript enum when the --immutable option is used.

Minor Changes

• ⚠️ Breaking Change: openapi-typescript@7 is needed to work. You’ll get type errors with openapi-typescript@6 and below.

• ⚠️ Breaking Change: The Middleware API has changed to be an object rather than (request, options) or (response, options). See Middleware docs for updated API.

• ⚠️ Breaking Change: The Content-Type header is no longer sent by default if a body payload is attached.

• ⚠️ Breaking Change: The customFetch type now calls fetch(input: string, init: RequestInit) and the types have been updated, rather than fetch(input: Request) introduced in 0.9.0. Edit: this has been reverted due to errors reported in some environments. The 0.9.0 behavior is still present where fetch(input: Request) is called for the final request.

• ⚠️ Breaking Change: the error type no longer is a union of all possible values; it will take the first it finds (due to some error type in some schemas being missing or incomplete, resulting in an unresolvable union)

Patch Changes

• Added id to middleware handlers that create a unique ID per-fetch