Skip to content

Latest commit

 

History

History
245 lines (173 loc) · 12.1 KB

RELEASE_NOTES.md

File metadata and controls

245 lines (173 loc) · 12.1 KB
Raw

Release Notes

0.10.4 (2018-07-20)

  • Fix issue where an object with a length property was incorrectly traversed (Issue #557)
  • Remove string dependency (PR #542)

0.10.3 (2017-10-13)

  • Remove support for nested controllers (Issue #537, #540)

0.10.2 (2017-10-10)

  • Added support for nested controllers (PR #422, Issue #283)
  • Fix issue where async controllers were not identified properly (Issue #443)
  • Fix issue where the failedValidation property was not set for Content-Type request validation errors (PR #420)
  • Fix issue where array body parameters would coerce non-array types into an array _(Issue #438)
  • Fix issue where swagger-ui shows an error icon trying to validate a swagger doc for an internal API (Issue #323, #370, #526)
  • Updated dependencies for security vulnerabilities (Issue #384, #535)

0.10.1 (2016-02-24)

  • Fix issue with initializing middleware with an invalid Swagger document (Issue 355)

0.10.0 (2016-02-22)

  • Bring back 84b3e83 which was reverted in 0.9.16

0.9.16 (2016-02-22)

  • Fix a bug where file parameters could produce a runtime error if req.files was empty, which can happen if you do not provide the parameter (Issue #350)
  • Revert v0.9.14 release (We will be adding it back for 0.10.0. Long story short, forces that I do not control require that I remove this fix and put it into a minor release instead to avoid upstream projects we do not maintain all the sudden reporting errors in response validation that didn't previously report them. I am sorry for having to do this, it was not my idea and I was against it completely.)

0.9.15 (2016-02-15)

  • Fixed an issue where multer.any() resulted in file parameters not being found properly (Issue 348)
  • Updated swagger-ui (Issue #349)

v0.9.14 (2016-02-05)

  • Fixed an issue where string an Array passed as a String wasn't handled properly (PR 341)

v0.9.13 (2016-02-02)

  • Upgrade json-refs for upstream bug fixes

v0.9.12 (2016-02-02)

  • Fixed a problem when initializing middleware where some errors could terminate without being logged

v0.9.11 (2016-01-14)

  • Added support for nested query parameters, as supported by qs (Issue #294)
  • Fixed a bug where the generated swagger-ui URL was wrong behind a proxy (Issue 297, 317)

v0.9.10 (2015-12-29)

  • Fixed an issue where consumes and produces values having a charset could break request/response validation (Issue 295)
  • Fixed an issue where with Swagger 2.0 documents, you cannot use #validateModel with an Array object (Issue 303)
  • Fixed an issue where array values were not validated against their validation constraints, on their format/type (Issue 300)
  • Fixed an issue with collectionFormat=multi not working right with singlar values (Issue 313)

v0.9.9 (2015-10-27)

  • Backport body-parser to run on environments without Uint8Array

v0.9.8 (2015-10-27)

  • Make it so you can provide your own text body parser (Issue 293)
  • Report all JSON Schema validation errors instead of failing on the first one (Issue 286)

v0.9.7 (2015-10-07)

  • Add ignoreMissingHandler option to swagger-router middleware to allow the API author to dictate how to handle missing handlers (Issue #274)
  • Fix bug with handling primitive body parameters
  • Make anyOf/oneOf JSON Schema validation errors more human readable (Issue #200)
  • Updated swagger-ui (Issue #273)
  • Updated the Swagger 2.0 JSON Schema

v0.9.6 (2015-09-30)

  • Add support for allowEmptyValue for parameters (Issue #282)
  • Better integer/number validation for parameter values (PR #279)
  • Fix missing mock support for date and date-time (Issue #277)

v0.9.5 (2015-08-20)

  • Fixed a problem with 304 requests running middleware twice (PR 270)

v0.9.4 (2015-08-19)

  • Fixed a problem with mock support in Hapi.js (Issue #269)

v0.9.3 (2015-08-17)

  • Fixed an issue where body parameters did not use their real schema during parameter processing (Issue #251)

v0.9.2 (2015-08-05)

  • Reverted a463907 (Issue #259)

v0.9.1 (2015-08-04)

  • Added support for URI encoded path parameters (Issue #230)
  • Fixed problem for Express where 204/204 remove the Content-Type header which makes response validation impossible (PR #258)
  • Fixed problem for references to within referenceable objects not marking the referenceable object as referenced (Issue #176)
  • Updated the build process to produce smaller browser binaries
  • Updated the Swagger 2.0 JSON Schema file

v0.9.0 (2015-07-09)

  • Added support for YAML remote references (Issue #222)
  • Added support to do operationId based mapping of controllers (Do not confuse this with Issue #219/#221) (PR #218)
  • Better error handling and debugging for request/response validation
  • Fix bug where a primitive string response could trigger a validation failure due to it treated as a model (Issue #224)
  • Fix bug where Swagger 2.0 default values were being type coerced unnecessarily (Issue #235)
  • Fix issue where mock responses did not have their Content-Type set propertly to application/json (Mock mode only works with JSON right now) (Issue #234)
  • Fix issue where custom formats would break validation (Issue #243)
  • Fix problem where references to missing parameters could result in a runtime error (Issue #233)
  • Updated swagger-router to throw a 500 when there is a configured route handler but it is missing (Issue #155)
  • Update swagger-metadata to set the value property of req.swagger.params to be the original value if type coercion fails
  • Update swagger-validator to not perform response validation whenever there is no response schema (PR, 231, Issue #232)
  • Updated version of swagger-converter (PR #226)

v0.8.7 (2015-05-22)

  • Added support for collectionFormat in swagger-metadata middleware (Issue #167)
  • Added support for file/multipart parameters and added tests for all known usages of form/formData parameters (Issue #60)
  • Added unit tests for the CLI (And fixed a number of inconsistencies/bugs as a result) (Issue #84)
  • Added validation that checks for operations with both a body and a form/formData parameter (Issue #211)
  • Always use YAML.load in the CLI when reading files instead of choosing JSON or YAML based on the file extension (Issue #215)
  • 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