Skip to content

Commit

Permalink
Release 1.10.2 (#120)
Browse files Browse the repository at this point in the history
  • Loading branch information
kalinchernev authored Jul 18, 2018
1 parent 6ea9c2b commit 64a6ec9
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 10 deletions.
12 changes: 9 additions & 3 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
.editorconfig
.git*
.js*
circle.yml
.jscsrc
.jsdocconf
.jshintignore
.jshintrc
.circleci
.c9
external.jsdoc
example/
docs/
jsdoc/
test/
.c9/
README.md
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down Expand Up @@ -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.
Expand All @@ -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`.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down

0 comments on commit 64a6ec9

Please sign in to comment.