Changed errors to responseCodes; Updated README;

README.md

@@ -12,7 +12,7 @@ Usage
 #### Add vegas-cmf/apidoc to composer.json dependencies
 
 ```
-"vegas-cmf/apidoc" : "1.0.0"
+"vegas-cmf/apidoc" : "1.0.*"
 ```
 
 and run composer update
@@ -93,10 +93,6 @@ class TestController extends ControllerAbstract
      *  headers=[
      *      {name: 'HTTP_X_AUTH', description: 'Authentication token'}
      *  ],
-     *  errors=[
-     *      {type: 'Error 404', description: 'Test was not found'},
-     *      {type: 'Error 500', description: 'Application error'}
-     *  ],
      *  requestFormat='JSON',
      *  requestContentType='application/json',
      *  request={
@@ -111,6 +107,13 @@ class TestController extends ControllerAbstract
      *      {name: 'id', type: 'MongoId', description: 'Test ID'},
      *      {name: 'name', type: 'string', description: 'Foo name'}
      *  ],
+     *  responseCodes=[
+     *      {code: 111, type: 'Info', description: 'Connection refused'},
+     *      {code: 200, type: 'Success', description: 'OK'},
+     *      {code: 300, type: 'Redirect', description: 'Found'},
+     *      {code: 404, type: 'Error', description: 'Record not found'},
+     *      {code: 500, type: 'Error', description: 'Application error'}
+     *  ],
      *  responseExample='{
      *      "id": "123",
      *      "name": "Test"
@@ -149,8 +152,9 @@ class TestController extends ControllerAbstract
      *  headers=[
      *      {name: 'HTTP_X_AUTH', description: 'Authentication token'}
      *  ],
-     *  errors=[
-     *      {type: 'Error 500', description: 'Unknown error'}
+     *  responseCodes=[
+     *      {code: 500, type: 'Error', description: 'Unknown error'}
+     *      {code: 200, type: 'Success', description: 'Ok'}
      *  ],
      *  requestFormat='JSON',
      *  requestContentType='application/json',
@@ -228,8 +232,6 @@ class TestController extends ControllerAbstract
 
 `headers`               Describes headers passed in request e.g. for Authorization
 
-`errors`                Describes errors
-
 `request`               Describes request
 
 `requestContentType`    Determines request Content-Type
@@ -246,6 +248,7 @@ class TestController extends ControllerAbstract
 
 `responseExample`       Example of response body
 
+`responseCodes`         Describes response status codes
 
 #### Create documentation layout ( you can use sample layout from tests/fixtures/app/layouts/partials/apiDoc directory ) and prepare output directory 
 
@@ -263,4 +266,4 @@ mkdir public/apiDoc
 php cli/cli.php app:apidoc generate
 ```
 
-Check example documentation [http://jsbin.com/sigebogegu/1](http://jsbin.com/sigebogegu/1)
+See sample [http://jsbin.com/xeyetevuro/1](http://jsbin.com/xeyetevuro/1)

composer.json

@@ -1,5 +1,6 @@
 {
     "name": "vegas-cmf/apidoc",
+    "version" : "",
     "type": "library",
     "description": "Vegas CMF API Documentor",
     "license": "MIT",

src/Collection/MethodCollection.php

@@ -29,9 +29,9 @@
  *  headers=[
  *      {name: 'HTTP_X_AUTH', description: 'Authentication token'}
  *  ],
- *  errors=[
- *      {type: 'Error 404', description: 'Object was not found'},
- *      {type: 'Error 500', description: 'Application error'}
+ *  responseCodes=[
+ *      {code: 400, type: 'Error', description: 'Object was not found'},
+ *      {code: 500, type: 'Error', description: 'Application error'}
  *  ],
  *  requestFormat='JSON',
  *  requestContentType='application/json',
@@ -67,8 +67,6 @@ class MethodCollection extends CollectionAbstract
 
     public $headers;
 
-    public $errors;
-
     public $request;
 
     public $requestContentType;
@@ -85,6 +83,8 @@ class MethodCollection extends CollectionAbstract
 
     public $responseExample;
 
+    public $responseCodes;
+
     public $description;
 
     public $name;

tests/fixtures/app/layouts/partials/apiDoc/partials/method.volt

@@ -19,7 +19,7 @@
             {{ partial('apiDoc/partials/method/method', ['method': method]) }}
             {{ partial('apiDoc/partials/method/url', ['method': method]) }}
             {{ partial('apiDoc/partials/method/params', ['method': method]) }}
-            {{ partial('apiDoc/partials/method/errors', ['method': method]) }}
+            {{ partial('apiDoc/partials/method/responseCodes', ['method': method]) }}
 
             <div class="clearfix"></div>
 

tests/fixtures/app/layouts/partials/apiDoc/partials/method/requestContentType.volt

@@ -1,3 +1,3 @@
 {% if method['requestContentType'] is defined and method['requestContentType']|length > 0 %}
-    <pre>Content-Type: <span class="label label-primary"><h5 style="display:inline;">{{ method['requestContentType'] }}</h5></span></pre>
+    <pre>Content-Type: <span class="label label-primary">{{ method['requestContentType'] }}</span></pre>
 {% endif %}

tests/fixtures/app/layouts/partials/apiDoc/partials/method/responseCodes.volt

@@ -0,0 +1,31 @@
+{% if method['responseCodes'] is defined and method['responseCodes'] is type('array') and method['responseCodes']|length > 0 %}
+    <h4>Errors</h4>
+    <table class="table table-bordered table-hover">
+        <tr>
+            <th>Code</th>
+            <th>Type</th>
+            <th>Description</th>
+        </tr>
+        {% for responseCode in method['responseCodes'] %}
+            <tr>
+                {% if responseCode['code'] < 200 %}
+                <td><span class="label label-info">{{ responseCode['code'] }}</span></td>
+                {% endif %}
+                {% if responseCode['code'] >= 200 and responseCode['code'] < 300 %}
+                <td><span class="label label-success">{{ responseCode['code'] }}</span></td>
+                {% endif %}
+                {% if responseCode['code'] >= 300 and responseCode['code'] < 400 %}
+                <td><span class="label label-default">{{ responseCode['code'] }}</span></td>
+                {% endif %}
+                {% if responseCode['code'] >= 400 and responseCode['code'] < 500 %}
+                <td><span class="label label-warning">{{ responseCode['code'] }}</span></td>
+                {% endif %}
+                {% if responseCode['code'] >= 500 and responseCode['code'] %}
+                <td><span class="label label-danger">{{ responseCode['code'] }}</span></td>
+                {% endif %}
+                <td>{{ responseCode['type'] }}</td>
+                <td>{{ responseCode['description'] }}</td>
+            </tr>
+        {% endfor %}
+    </table>
+{% endif %}

tests/fixtures/app/modules/ApiTest/controllers/FooController.php

@@ -30,9 +30,9 @@ class FooController extends ControllerAbstract
      *  headers=[
      *      {name: 'HTTP_X_AUTH', description: 'Authentication token'}
      *  ],
-     *  errors=[
-     *      {type: 'Error 404', description: 'Foo was not found'},
-     *      {type: 'Error 500', description: 'Application error'}
+     *  responseCodes=[
+     *      {code: 404, type: 'Error', description: 'Record not found'},
+     *      {code: 500, type: 'Error', description: 'Application error'}
      *  ],
      *  responseFormat='JSON',
      *  responseContentType='application/json',
@@ -78,8 +78,8 @@ public function getAction()
      *  headers=[
      *      {name: 'HTTP_X_AUTH', description: 'Authentication token'}
      *  ],
-     *  errors=[
-     *      {type: 'Error 500', description: 'Unknown error'}
+     *  responseCodes=[
+     *      {code: 500, type: 'Error', description: 'Application error'}
      *  ],
      *  responseFormat='JSON',
      *  responseContentType='application/json',

tests/fixtures/app/modules/ApiTest/controllers/TestController.php

@@ -30,10 +30,13 @@ class TestController extends ControllerAbstract
      *  headers={
      *      {name: 'HTTP_X_AUTH', description: 'Authentication token'}
      *  },
-     *  errors={
-     *      {type: 'Error 404', description: 'Test was not found'},
-     *      {type: 'Error 500', description: 'Application error'}
-     *  },
+     *  responseCodes=[
+     *      {code: 111, type: 'Info', description: 'Connection refused'},
+     *      {code: 200, type: 'Success', description: 'OK'},
+     *      {code: 300, type: 'Redirect', description: 'Found'},
+     *      {code: 404, type: 'Error', description: 'Record not found'},
+     *      {code: 500, type: 'Error', description: 'Application error'}
+     *  ],
      *  requestFormat='JSON',
      *  requestContentType='application/json',
      *  request={
@@ -89,9 +92,9 @@ public function getAction()
      *  headers={
      *      {name: 'HTTP_X_AUTH', description: 'Authentication token'}
      *  },
-     *  errors={
-     *      {type: 'Error 500', description: 'Unknown error'}
-     *  },
+     *  responseCodes=[
+     *      {code: 500, type: 'Error', description: 'Application error'}
+     *  ],
      *  requestFormat='JSON',
      *  requestContentType='application/json',
      *  request='',

tests/fixtures/app/modules/ApiTest/controllers/v2/NestedController.php

@@ -30,9 +30,9 @@ class NestedController extends ControllerAbstract
      *  headers=[
      *      {name: 'HTTP_X_AUTH', description: 'Authentication token'}
      *  ],
-     *  errors=[
-     *      {type: 'Error 404', description: 'Nested was not found'},
-     *      {type: 'Error 500', description: 'Application error'}
+     *  responseCodes=[
+     *      {code: 404, type: 'Error', description: 'Record not found'},
+     *      {code: 500, type: 'Error', description: 'Application error'}
      *  ],
      *  responseFormat='JSON',
      *  responseContentType='application/json',
@@ -78,8 +78,8 @@ public function getAction()
      *  headers=[
      *      {name: 'HTTP_X_AUTH', description: 'Authentication token'}
      *  ],
-     *  errors=[
-     *      {type: 'Error 500', description: 'Unknown error'}
+     *  responseCodes=[
+     *      {code: 500, type: 'Error', description: 'Application error'}
      *  ],
      *  responseFormat='JSON',
      *  responseContentType='application/json',