Skip to content

Latest commit

 

History

History
62 lines (33 loc) · 4.98 KB

CHANGELOG.md

File metadata and controls

62 lines (33 loc) · 4.98 KB
Raw

Change Log

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

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