Skip to content

Latest commit

 

History

History
45 lines (24 loc) · 4.12 KB

CHANGELOG.md

File metadata and controls

45 lines (24 loc) · 4.12 KB

Change Log

All notable changes will be documented in this file. Swagger Parser adheres to Semantic Versioning.

v3.3.0 (2015-10-02)

Updated to the latest version of the Official Swagger 2.0 Schema. The schema hadn't been updated for six months, so Swagger Parser was missing several recent changes.

Full Changelog

v3.2.0 (2015-10-01)

Swagger Parser now uses call-me-maybe to support promises or callbacks.

Full Changelog

v3.1.0 (2015-09-28)

Fixed several bugs with circular references, particularly with the validate() method.

Added a new $refs.circular option to determine how circular references are handled. Options are fully-dereferencing them (default), throwing an error, or ignoring them.

Full Changelog

v3.0.0 (2015-09-25)

This is a complete rewrite of Swagger Parser. Major changes include:

Swagger 2.0 Compliant
Previous versions of Swagger Parser were based on early drafts of Swagger 2.0, and were not compliant with the final version of the spec. Swagger Parser v3.0 is now compliant with the final spec as well as related specs, such as JSON Reference and JSON Pointer

All-New API
The old API only had a single method: parse(). But depending on which options you passed it, the method did much more than its name implied. The new API has separate methods to make things a bit more intuitive. The most commonly used will be validate(), bundle(), and dereference(). The parse() and resolve() methods are also available, but these are mostly just for internal use by the other methods.

Asynchronous API
The old API was "asynchronous", but it relied on global state, so it did not support multiple simultaneous operations. The new API is truly asynchronous and supports both ES6 Promises and Node-style callbacks.

New JSON Schema Validator
Swagger Parser has switched from tv4 to Z-Schema, which is faster and performs more accurate validation. This means that some APIs that previously passed validation will now fail. But that's a good thing!

Full Changelog