From a85c4b8eeff3c424bb52569f1cd13cd87f36b64b Mon Sep 17 00:00:00 2001 From: Zilvinas Vilutis Date: Thu, 17 Nov 2016 10:34:54 -0800 Subject: [PATCH] Updating sample to comply with Swagger v2 --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b7219eb6..184101d8 100644 --- a/README.md +++ b/README.md @@ -95,7 +95,7 @@ model and add fields. ```javascript /** * @swagger - * definition: + * definitions: * NewUser: * type: object * required: @@ -212,4 +212,4 @@ Common usage: - Help menu: `./bin/swagger-jsdoc -h` - Specify a swagger definition file: `./bin/swagger-jsdoc -d example/swaggerDef.js` - could be any .js or .json file which will be `require()`-ed and parsed/validated as JSON. - Specify files with documentation: `./bin/swagger-jsdoc example/routes.js example/routes2.js` - free form input, can be before or after definition -- Specify output file (optional): `./bin/swagger-jsdoc -o output.json` - swaggerSpec.json will be created if this is not set. \ No newline at end of file +- Specify output file (optional): `./bin/swagger-jsdoc -o output.json` - swaggerSpec.json will be created if this is not set.