From 64a6ec9a436a88e8dbfeba53b00fd91cce77c984 Mon Sep 17 00:00:00 2001 From: Kalin Chernev Date: Wed, 18 Jul 2018 20:39:12 +0200 Subject: [PATCH] Release 1.10.2 (#120) --- .npmignore | 12 +++++++++--- README.md | 12 ++++++------ package.json | 2 +- 3 files changed, 16 insertions(+), 10 deletions(-) diff --git a/.npmignore b/.npmignore index 6a6c1468..402894dd 100644 --- a/.npmignore +++ b/.npmignore @@ -1,8 +1,14 @@ +.editorconfig .git* -.js* -circle.yml +.jscsrc +.jsdocconf +.jshintignore +.jshintrc +.circleci +.c9 external.jsdoc example/ +docs/ jsdoc/ test/ -.c9/ +README.md diff --git a/README.md b/README.md index 95015b01..a4c7d765 100644 --- a/README.md +++ b/README.md @@ -5,10 +5,9 @@ documentation, servers, clients, tests and much more based on the rich [OpenAPI [![npm Version](https://img.shields.io/npm/v/swagger-jsdoc.svg)](https://www.npmjs.com/package/swagger-jsdoc) [![npm Downloads](https://img.shields.io/npm/dm/swagger-jsdoc.svg)](https://www.npmjs.com/package/swagger-jsdoc) - [![Circle CI](https://img.shields.io/circleci/project/Surnet/swagger-jsdoc/master.svg)](https://circleci.com/gh/Surnet/swagger-jsdoc) [![Documentation Status](http://inch-ci.org/github/Surnet/swagger-jsdoc.svg?branch=master&style=flat)](http://inch-ci.org/github/Surnet/swagger-jsdoc) -[![Known Vulnerabilities](https://snyk.io/test/npm/swagger-jsdoc/badge.svg)](https://snyk.io/test/npm/swagger-jsdoc) +[![Known Vulnerabilities](https://snyk.io/test/github/Surnet/swagger-jsdoc/badge.svg?targetFile=package.json)](https://snyk.io/test/github/Surnet/swagger-jsdoc?targetFile=package.json) ## Goals @@ -22,11 +21,13 @@ technology as long as both sides comply with the specification. Thus, the `swagger-jsdoc` project assumes that you want document your existing working code in a way to "give life" to it, generating a specification which can then be feeded into other Swagger tools, and not the vice-versa. If you prefer to write the OpenAPI specification first and separately, you might check other projects facilitating this, such as -- [swagger-editor](http://swagger.io/swagger-editor/) + +- [swagger-editor](http://swagger.io/swagger-editor/) - [swagger-node](https://github.com/swagger-api/swagger-node) ## Supported versions -* [OpenAPI 2.0](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md) (previously known as Swagger) + +- [OpenAPI 2.0](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md) (previously known as Swagger) ## Install @@ -60,7 +61,6 @@ $ npm start The swagger spec will be served at http://localhost:3000/api-docs.json - ### CLI You can also use the tool via [command line interface](./docs/CLI.md). It supports selecting multiple files, recursive subdirectories and watch task for continuous listening of changes in your code. @@ -72,4 +72,4 @@ You can also use the tool via [command line interface](./docs/CLI.md). It suppor - Write detailed commit messages, comment unclear code blocks and update unit tests - Push to your own repository and create a new PR to merge back into this repository -Note: If there are additions to the swagger definition object ensure that the output object keys comply with the swagger specification. If there are keys that do not comply add them to the `excludedSwaggerProperties` list in `lib/swagger-helpers.js`. +Note: If there are additions to the swagger definition object ensure that the output object keys comply with the swagger specification. If there are keys that do not comply add them to the `excludedSwaggerProperties` list in `lib/swagger-helpers.js`. diff --git a/package.json b/package.json index 83a45d3e..c08dc912 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "swagger-jsdoc", - "version": "1.9.7", + "version": "1.10.2", "description": "Generates swagger doc based on JSDoc", "main": "index.js", "scripts": {