Last updated 3 days ago

Reference docs changelog

1.3.16 (2021-02-26)

Fixes

  • Resolved an issue with multi-version URLs for path-prefixed docs.
  • Path-prefixed docs output now works with URLs that don't end with a trailing slash.

1.3.15 (2021-02-16)

Features

  • Hostnames ending with .localhost are now supported when using Reference docs on-premise (running a local development server).
  • Reference docs CLI now supports the --gzip flag that outputs GZIP-compressed files directly when bundling your API definitions.

1.3.14 (2021-02-15)

Fixes

  • Resolved an issue with a false-positive "Recursive" label being displayed for parameters when using some combination of allOf and oneOf.
  • The request payload body in the Try It console was not visible until the user clicked in the console area.

1.3.12 (2021-02-02)

Fixes

  • Resolved an issue with the "Try it" console crashing for API definitions without security schemes.

1.3.11 (2021-01-31)

Fixes

  • The menu toggle button in mobile view is now functional again. Reference docs in Workflows must be rebuilt for this change to take effect.
  • Implemented the latest fixes from Redoc to resolve crashes on multiple examples in the parameter object and on code highlights for boolean or number values in examples.

1.3.10 (2021-01-25)

Fixes

  • The HTTP scheme name (e.g. Bearer) is now capitalized in code samples.

1.3.9 (2021-01-14)

Fixes

  • Upgraded internal dependencies.
  • Improved support for HTTP Bearer scheme.
  • Switched to enableStaticRendering instead of the deprecated useStaticRendering.

1.3.7 (2020-12-16)

Features

  • Reference docs now support auto-generated C# and Python code samples.

Fixes

  • Resolved a number of typings and MobX observables issues.
  • Fixed default indentation for generated code samples.
  • Resolved an issue with broken Node.js and JavaScript code samples.
  • Resolved an issue with Basic Authentication in Python code samples.

1.3.6 (2020-12-01)

Features

  • The "Try it" button has moved to a new place.

Fixes

  • Resolved an issue with failing examples that had empty headers.
  • Deprecated specs in favor of definitions.
  • Fixed an issue with empty headers.

1.3.5 (2020-11-15)

Fixes

  • Fixed a memory overflow issue on some complicated definitions (with combinatorial explosion pattern). This change has been propagated to Redocly Workflows.

1.3.4 (2020-11-11)

Fixes

  • Upgraded some internal dependencies.
  • Resolved mime-type issues in code samples and issues with OAuth2 clientCredentials with empty scopes.
  • Resolved an issue with hash history removing page path on scroll.

1.3.3 (2020-11-05)

Features

  • Implemented improvements for handling OAuth2.

1.3.2 (2020-11-02)

Fixes

  • Removed console.log.

1.3.1 (2020-10-29)

Fixes

  • Fixed TypeScript emit issues.

1.3.0 (2020-10-29)

Features

  • Integration with our open-source product Redoc has been upgraded to the latest version to support the hideRequestPayloadSample configuration option.
  • Improved Basic Authentication handling.
  • Implemented a number of improvements to code samples.
  • Converted code samples to async/await.
  • Renamed cURL to curl.

Fixes

  • Fixed url-encoded and x-www-form-urlencoded.
  • Exported setSecurityDetails from standalone package.
  • Resolved an issue with multiple auth types.
  • Implemented a number of SSR and internal fixes.
  • Copied httpsnippet to the repository.

1.2.8 (2020-10-28)

Fixes

  • Resolved an issue with broken oneOf when used in recursive schemas.

1.2.7 (2020-10-27)

Features

  • Implemented a new theming option called schema.breakFieldNames.

Fixes

  • Fixed a crash in next-to button caused by an empty tag.

1.2.6 (2020-10-21)

Fixes

  • Resolved an issue with a broken package due to an invalid .npmignore setup.
  • Fixed a server-side crash caused by consecutive use of the "Try it" console.

1.2.5 (2020-10-16)

Features

  • Implemented the corsProxyUrl configuration parameter.

Fixes

  • Fixed a crash caused by empty response.
  • Resolved an issue with "Try it" console crashing for API definitions with server variables.
  • Implemented URL protocol normalization to automatically add https when a URL starts with //.

1.2.4 (2020-10-06)

Features

  • Search is now loading from webworker.

1.2.3 (2020-09-21)

Fixes

  • Upgraded openapi-sampler to fix a memory overflow issue.
  • Fixed a crash caused by empty auth schema.

1.2.2 (2020-09-14)

Features

  • Implemented support for OAuth2 implicit and OpenID Connect.

Fixes

  • Crashes will no longer happen on "Try it" blob response.
  • Fixed issues that caused crashes and broken server-side rendering when search is disabled.

1.2.1 (2020-10-10)

Features

  • Reference docs can now use schema or pointer for the schema component.

Fixes

  • Full width panel is now used for components without samples.
  • Fixed a crash that would happen when disposing the search store.
  • Resolved an issue with wrong console width set on initial load.
  • Fixed a broken import in the "Try it" feature.

1.2.0 (2020-08-25)

Reference docs 1.2.0 release!