diff --git a/CHANGELOG.md b/CHANGELOG.md index c40f911a..a8950245 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,13 +4,16 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). -## [Unreleased] +## [0.8.6] - 2018-12-18 ### Added - `notContain` rulesets can now support pattern matching. ([#208] via [@erunion]) ### Fixed - Support options after the command name, and at the end of the command ([#229]) +### Improved +- Bumped `json-schema-to-openapi-schema` to v0.3.0 to handle if/then/else, const, exclusiveMiniumum/exclusiveMaximum, and empty `items` in type: array. Thanks [@MikeRalphson]! [@erunion]: https://github.com/erunion +[@MikeRalphson]: https://github.com/MikeRalphson [#208]: https://github.com/wework/speccy/issues/208 [#229]: https://github.com/wework/speccy/pull/229 diff --git a/README.md b/README.md index 6ebbce1e..4abcf2ae 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,18 @@ Currently tracking [v3.0.0](https://github.com/OAI/OpenAPI-Specification/blob/ma If you want to run speccy on OpenAPI (f.k.a Swagger) v2.0 specs, run it through [swagger2openapi] first and speccy can give advice on the output. +## Setup + +You can install this node module via NPM or Yarn. + +```sh +$ npm install speccy -g +# or +$ yarn global add speccy +``` + +Alternatively, you can use it with Docker (see "Using Docker" below.) + ## Usage ``` @@ -189,7 +201,7 @@ To lint your specifications before committing them you can use [lint-staged](htt ``` "husky": { - "hooks": { + "hooks": { "pre-commit": "lint-staged" } }, diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock index 64de7854..3c789613 100644 --- a/docs/Gemfile.lock +++ b/docs/Gemfile.lock @@ -223,7 +223,7 @@ GEM pathutil (0.16.1) forwardable-extended (~> 2.6) public_suffix (2.0.5) - rack (1.6.10) + rack (1.6.11) rb-fsevent (0.10.3) rb-inotify (0.9.10) ffi (>= 0.5.0, < 2) @@ -263,4 +263,4 @@ DEPENDENCIES tzinfo-data BUNDLED WITH - 1.16.6 + 1.17.2 diff --git a/package-lock.json b/package-lock.json index 1cd598b5..95a59f58 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "speccy", - "version": "0.8.5", + "version": "0.8.6", "lockfileVersion": 1, "requires": true, "dependencies": { @@ -2405,7 +2405,6 @@ "version": "0.1.4", "bundled": true, "dev": true, - "optional": true, "requires": { "kind-of": "^3.0.2", "longest": "^1.0.1", @@ -2730,8 +2729,7 @@ "is-buffer": { "version": "1.1.6", "bundled": true, - "dev": true, - "optional": true + "dev": true }, "is-builtin-module": { "version": "1.0.0", @@ -2815,7 +2813,6 @@ "version": "3.2.2", "bundled": true, "dev": true, - "optional": true, "requires": { "is-buffer": "^1.1.5" } @@ -2862,8 +2859,7 @@ "longest": { "version": "1.0.1", "bundled": true, - "dev": true, - "optional": true + "dev": true }, "lru-cache": { "version": "4.1.3", @@ -3129,8 +3125,7 @@ "repeat-string": { "version": "1.6.1", "bundled": true, - "dev": true, - "optional": true + "dev": true }, "require-directory": { "version": "2.1.1", diff --git a/package.json b/package.json index 38b27ccd..38768a86 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "speccy", - "version": "0.8.5", + "version": "0.8.6", "description": "An OpenAPI v3 development workflow assistant", "homepage": "https://speccy.io/", "bin": {