apidoc - npm Package Compare versions

Comparing version 0.2.1 to 0.2.2

CHANGELOG.md

 # apiDoc Changelog
 
+#### 0.2.2
+Bugfix: Template not show @apiSuccessExample @apiErrorExample.
+
 #### 0.2.1
@@ -4,0 +7,0 @@ Bugfix: executable line delimiters.

example/example.js

@@ -26,2 +26,7 @@ /**
  *
+ * @apiExample CURL example:
+ *     curl -i -X POST http://localhost:3001/example
+ *          -H 'Content-Type: application/json' \
+ *          -d '{ "id": "4711" }'
+ *
  * @apiSuccess {String} id         The Users-ID.
@@ -31,6 +36,14 @@ * @apiSuccess {Date}   registered Registration Date.
  *
+ * @apiSuccessExample Success-Response (example):
+ *     HTTP/1.1 200 OK
+ *     {
+ *       "id": "4711"
+ *       "registered": "31.01.2013"
+ *       "name": "John Doe"
+ *     }
+ *
  * @apiError NoAccessRight Only authenticated Admins can access the data.
  * @apiError UserNotFound   The <code>id</code> of the User was not found.
  * 
- * @apiErrorExample Response (example):
+ * @apiErrorExample Error-Response (example):
  *     HTTP/1.1 401 Not Authenticated
@@ -37,0 +50,0 @@ *     {

package.json

 {
   "name": "apidoc",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "RESTful web API Documentation Generator",
@@ -5,0 +5,0 @@ "author": "Peter Rottmann <[e-mail]>",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1094233

increased by0.04%

Lines of code

8205

increased by0.16%

No dependency changes