Skip to content

Latest commit

 

History

History
184 lines (89 loc) · 11.9 KB

CHANGELOG.md

File metadata and controls

184 lines (89 loc) · 11.9 KB
Raw

Change Log

All notable changes will be documented in this file. JSON Schema $Ref Parser adheres to Semantic Versioning.

v9.0.0 (2020-04-21)

Breaking Changes

Other Changes

Full Changelog

v8.0.0 (2020-03-13)

  • Moved JSON Schema $Ref Parser to the @APIDevTools scope on NPM

  • The "json-schema-ref-parser" NPM package is now just a wrapper around the scoped "@apidevtools/json-schema-ref-parser" package

Full Changelog

v7.1.0 (2019-06-21)

Full Changelog

v7.0.0 (2019-06-11)

  • Dropped support for Node 6

  • Updated all code to ES6+ syntax (async/await, template literals, arrow functions, etc.)

  • No longer including a pre-built bundle in the package. such as Webpack, Rollup, Parcel, or Browserify to include JSON Schema $Ref Parser in your app

Full Changelog

v6.0.0 (2018-10-04)

  • Dropped support for Bower, since it has been deprecated

  • Removed the debug dependency

Full Changelog

v5.1.0 (2018-07-11)

  • Improved the logic of the bundle() method to produce shorter reference paths when possible. This is not a breaking change, since both the old reference paths and the new reference paths are valid. The new ones are just shorter. Big thanks to @hipstersmoothie for PR #68, which helped a lot with this.

Full Changelog

v5.0.0 (2018-03-18)

This release contains two bug fixes related to file paths. They are technically breaking changes — hence the major version bump — but they're both edge cases that probably won't affect most users.

  • Fixed a bug in the $refs.paths() and $refs.values() methods that caused the path of the root schema file to always be represented as a URL, rather than a filesystem path (see this commit)

  • Merged PR #75, which resolves issue #76. Error messages no longer include the current working directory path when there is no file path.

Full Changelog

v4.1.0 (2018-01-17)

  • Updated dependencies

  • Improved the bundle() algorithm to favor direct references rather than indirect references (see PR #62 for details). This will produce different bundled output than previous versions for some schemas. Both the old output and the new output are valid, but the new output is arguably better.

Full Changelog

v4.0.0 (2017-10-13)

Breaking Changes

Minor Changes

Full Changelog

v3.3.0 (2017-08-09)

  • Updated dependencies

  • PR #30 - Added a browser field to the package.json file to support bundlers such as Browserify, Rollup, and Webpack

  • PR #45 - Implemented a temporary workaround for issue #42. JSON Schema $Ref Parser does not currently support named internal references, but support will be added in the next major release.

Full Changelog

v3.0.0 (2016-04-03)

Plug-ins !!!

That's the major new feature in this version. Originally requested in PR #8, and refined a few times over the past few months, the plug-in API is now finalized and ready to use. You can now define your own resolvers and parsers.

Breaking Changes

The available options have changed, mostly due to the new plug-in API. There's not a one-to-one mapping of old options to new options, so you'll have to read the docs and determine which options you need to set. If any. The out-of-the-box configuration works for most people.

All of the caching options have been removed. Instead, all files are now cached, and the entire cache is reset for each new parse operation. Caching options may come back in a future release, if there is enough demand for it. If you used the old caching options, please open an issue and explain your use-case and requirements. I need a better understanding of what caching functionality is actually needed by users.

Bug Fixes

Lots of little bug fixes. The only major bug fix is to support root-level $refs

Full Changelog

v2.2.0 (2016-01-03)

This version includes a complete rewrite of the bundle method method, mostly to fix this bug, but also to address a few edge-cases that weren't handled before. As a side-effect of this rewrite, there was also some pretty significant refactoring and code-cleanup done throughout the codebase.

Despite the significant code changes, there were no changes to any public-facing APIs, and all tests are passing as expected.

Full Changelog

v2.1.0 (2015-12-31)

JSON Schema $Ref Parser now automatically follows HTTP redirects. This is especially great for servers that automatically "ugrade" your connection from HTTP to HTTPS via a 301 redirect. Now that won't break your code.

There are a few new options that allow you to set the number of redirects (default is 5) and a few other HTTP request properties.

Full Changelog

v2.0.0 (2015-12-31)

Bumping the major version number because this change technically breaks backward-compatibility — although I doubt it will actually affect many people. Basically, if you're using JSON Schema $Ref Parser to download files from a CORS-enabled server that requires authentication, then you'll need to set the http.withCredentials option to true.

$RefParser.dereference('http://some.server.com/file.json', {
    http: { withCredentials: true }
});

Full Changelog