Skip to content

Latest commit

 

History

History
113 lines (85 loc) · 5.88 KB

RELEASE_NOTES.md

File metadata and controls

113 lines (85 loc) · 5.88 KB

Release Notes

TBD

  • Fixed bug with inline schemas used for inheritance being marked as unused (Issue #187)
  • Fixed bug in swaggerUi middleware that did not allow an explicit apiDocs path for Swagger 2.0 documents (Issue #183)
  • Updated CLI validation to have a --verbose flag to output pertinent verbose information regardless of validation result (Issue #179)

v0.8.6 (2015-04-16)

  • Fixed bug with CLI not handling invalid invocations properly
  • Fixed bug with bundled parsers being called unnecessarily in middleware (Issues #172)
  • Fixed bug with inline schemas for Swagger 2.0 inheritance (Issue #173)
  • Fixed bug with middleware initialization due to upstream json-resf bug (Issue #190)
  • Fixed bug with validator middleware where the error object had the right message but the error stack did not (Issue #175)
  • Update Swagger 2.0 JSON Schema from swagger-spec (Issue #189)
  • Update Swagger UI to latest (Issue #163)

v0.8.5 (2015-02-20)

  • Fix bug in swagger-metadata middleware that could cause next to be called more than once due to a downstream error (Issue #165)

v0.8.4 (2015-02-19)

  • Support one single Swagger path definition being all undefined subpaths for said path (Issue #162)

v0.8.3 (2015-02-16)

  • Fixed bug where unresolvable model references in operation parameters for Swagger 1.2 were not flagged
  • Fixed bug in swagger-router where using mock mode caused the server to stop responding after the first request (Issue #152)

v0.8.2 (2015-02-09)

  • Debugging support (Issue #8)
  • Each middleware provided now is one implementation instead of one implementation per Swagger version (This has zero consumer impact unless you were initializng Swagger middleware directly)
  • Validate operation to ensure only one body parameter (Issue #136)

v0.8.1 (2015-01-29)

  • swagger-tools CLI displays help output when an invalid command or no command is passed to swagger-tools CLI (Issue #130)
  • swagger-tools CLI handles invalid Swagger documents caused by an invalid/missing Swagger version (Issue #129)
  • Bumped all dependencies and development dependencies due to some upstream updates causing issues

v0.8.0 (2015-01-27)

  • Better handling of references to invalid objects (Issue #120, #121)
  • Fix bug validating models with a default attribute (Issue #124)
  • Fix bug validating models without properties (Issue #122)
  • swaggerMetadata middleware now converts paramters to their appropriate type (Issue #119)
  • swaggerRouter middleware now handles void responses for mock mode (Issue #112)
  • swaggerRouter middleware now wraps controller calls in try/catch block and sends errors downstream via next (Issue #123)
  • swaggerSecurity middleware now sends authentication/authorization errors downstream via next (Issue #117)
  • swaggerSecurity middleware now handles API Key authentication/authorization (Issue #128)
  • swaggerUi middleware now allows you to serve your own custom swagger-ui resources (Issue #111)

v0.7.4

  • Attached the original data sent to res.end to response validation errors (Issue #110)
  • Response validation for Swagger 2.0 now takes the default response into account when validating (Issue #99)
  • Removed requirement for servers to wire up body/query string parsers (We default to body-parser and qs respectively.) (Issue #70)

v0.7.3

  • Updated the version of Z-Schema being used to fix some browser issues (Issue #94)
  • Updated to build/test the browser using gulp gulp test (Issue #96)
  • Specification APIs for Swagger 2.0 now do a full validation prior to performing the business logic behidn the API (Issue #97)
  • Fixed Quick Start documentation example (Issue 101)
  • Fixed a bug in the CLI where local YAML files were not processed properly (Issue #104)
  • Fixed a bug where erroneous validation errors were thrown for valid files due to paths with path paramters and vendor extensions (Issue #103)

v0.7.2

(Contained only upstream release changes)

v0.7.1

  • Added API/CLI for Swagger 1.2 to 2.0 conversion (Issue #41)
  • Fix browser build (Issue #90)
  • Properly support Swagger 2.0 form parameters (Issue #88)
  • Support validating responses (Issue #25)

v0.7.0

(Contains breaking changes)

  • Add an API (Specification#resolve) to get all of or part of a Swagger document as fully resolved (Issue #63)
  • All Specification APIs now require an error-first callback as the last argument
  • Fix support for header parameters where case caused an issue (Issue #82)
  • Make sure tests that were async were written properly (Issue #65)
  • Middleware now requires you to use the initializeMiddleware function during server initialization to validate your Swagger document(s) and return the appropriate middlewares (Issue #77)
  • Refactor to support upstream path-level authorizations in Swagger 1.2 (Issue #27)
  • Support path parameters that are not path segments (Issue #72)
  • Support references throughout the Swagger 2.0 document (Issues: #38, #55, #68, #73, #79)
  • Support remote reference (Issue #54)
  • Support Swagger 2.0 security (Issue #69)
  • Support validating remote files from the CLI (Issue #74)
  • Support validating YAML files from the CLI (Issue #75)
  • Switched from jjv+jjve for JSON Schema validation to ZSchema
  • Validate situation in Swagger 1.2 where the model id and the model's id field are not the same (Issue #71)
  • When printing out validation errors/warnings, support inner errors/warnings (Issue #85)
  • Various minor bug fixes that did not result in issues
  • Various documentation/example fixes to support the changes above