From d2b194c82ea2956d8c424c6c3b1b1269c18a94a9 Mon Sep 17 00:00:00 2001 From: Kalin Chernev Date: Sat, 12 Dec 2020 18:45:59 +0100 Subject: [PATCH] Update changelog --- CHANGELOG.md | 7 +++++++ docs/CLI.md | 14 +++++++------- 2 files changed, 14 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 530b388e..0f6f655d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,14 @@ ## Change Log +### v6.0.0-rc.4 (2020/12/12 17:15 +00:00) + +- [#234](https://github.com/Surnet/swagger-jsdoc/pull/234) Remove 'api' attr from swagger definition (#234) (@mits87) + ### v6.0.0-rc.3 (2020/11/28 15:37 +00:00) +- [7ec0825](https://github.com/Surnet/swagger-jsdoc/commit/7ec08259e1ca36343be0a7ed5e3a2475b28b325a) chore: prepare v6.0.0-rc.3 (@kalinchernev) +- [d99fbd5](https://github.com/Surnet/swagger-jsdoc/commit/d99fbd56599cbabbb3eaeee1497a5060e4e4bbc4) chore: prepare v6.0.0-rc.3 (@kalinchernev) +- [9686d62](https://github.com/Surnet/swagger-jsdoc/commit/9686d62adbca6544241ac47027a23f8aa05a379b) docs: update examples (@kalinchernev) - [c4cea4c](https://github.com/Surnet/swagger-jsdoc/commit/c4cea4caaf94624d63e67be68f1e72a47d776cdc) docs: update changelog upcoming (@kalinchernev) - [74395f2](https://github.com/Surnet/swagger-jsdoc/commit/74395f243d5e8977d8b20a253a90320318bc03f1) feat: support custom encoding in api files (@kalinchernev) - [270c0af](https://github.com/Surnet/swagger-jsdoc/commit/270c0af310d9c0090b4f9f48ad051565d5f4bf7e) documentation fixes (@kalinchernev) diff --git a/docs/CLI.md b/docs/CLI.md index 34be03ff..9bbee2c3 100644 --- a/docs/CLI.md +++ b/docs/CLI.md @@ -22,17 +22,17 @@ swagger-jsdoc -h ### Definition file -Adding `-d` parameter you can speciify easily a definition file. +Set with `--definition` (or `-d`) flag: ```bash -swagger-jsdoc -d swaggerDefinition.js route*.js component*.yaml +swagger-jsdoc -d swaggerDefinition.js ``` -This could be any `.js`, `.json`, `.yml` or `.yaml` extensions. +Acceptable file extensions: `.js`, `.json`, `.yml`, `.yaml`. -### Input files (optional) +### Input files -Except the `definition file` mostly you would like to add `apis` definitions to swagger. You can specify it like following: +Set through arguments. One by one: @@ -48,7 +48,7 @@ swagger-jsdoc -d swaggerDefinition.js route*.js component*.yaml [Glob patterns](https://github.com/isaacs/node-glob) are acceptable to match multiple files with same extension `*.js`, `*.php`, etc. or patterns selecting files in nested folders as `**/*.js`, `**/*.php`, etc. -These paths are relative to current directory from where `swagger-jsdoc` is ran, not the application holding the APIs. +Paths are relative to the current working directory. ### Output file (optional) @@ -58,4 +58,4 @@ The output is `swagger.json` by default, but can be changed: swagger-jsdoc -d swaggerDefinition.js route1.js -o my_spec.json ``` -When `.yaml` or `.yml` extension is used, the specification will be parsed and saved in YAML. +When output file extension is `.yaml` or `.yml`, the specification will be parsed and saved in YAML format.