Api documentation updates.

GrupaZero · Aug 19, 2016 · 3e2ec8a · 3e2ec8a
1 parent a3f6b84
commit 3e2ec8a
Show file tree

Hide file tree

Showing 5 changed files with 48 additions and 6 deletions.
diff --git a/docs/api_data.js b/docs/api_data.js
@@ -1,11 +1,31 @@
 define({ "api": [
   {
     "type": "delete",
-    "url": "/admin/blocks",
+    "url": "/admin/blocks/:id?force=:forceDelete",
     "title": "6. DELETE the specified entity",
     "version": "0.1.0",
     "name": "DeleteBlock",
     "group": "Block",
+    "parameter": {
+      "fields": {
+        "": [
+          {
+            "group": "Block",
+            "type": "Number",
+            "optional": false,
+            "field": "id",
+            "description": "<p>ID of the block.</p>"
+          },
+          {
+            "group": "Block",
+            "type": "Boolean",
+            "optional": false,
+            "field": "forceDelete",
+            "description": "<p>Idicates block should be permanently deleted or not.</p>"
+          }
+        ]
+      }
+    },
     "permission": [
       {
         "name": "admin",

diff --git a/docs/api_data.json b/docs/api_data.json
@@ -1,11 +1,31 @@
 [
   {
     "type": "delete",
-    "url": "/admin/blocks",
+    "url": "/admin/blocks/:id?force=:forceDelete",
     "title": "6. DELETE the specified entity",
     "version": "0.1.0",
     "name": "DeleteBlock",
     "group": "Block",
+    "parameter": {
+      "fields": {
+        "": [
+          {
+            "group": "Block",
+            "type": "Number",
+            "optional": false,
+            "field": "id",
+            "description": "<p>ID of the block.</p>"
+          },
+          {
+            "group": "Block",
+            "type": "Boolean",
+            "optional": false,
+            "field": "forceDelete",
+            "description": "<p>Idicates block should be permanently deleted or not.</p>"
+          }
+        ]
+      }
+    },
     "permission": [
       {
         "name": "admin",

diff --git a/docs/api_project.js b/docs/api_project.js
@@ -8,7 +8,7 @@ define({
   "apidoc": "0.2.0",
   "generator": {
     "name": "apidoc",
-    "time": "2016-08-18T08:43:53.081Z",
+    "time": "2016-08-18T11:02:18.340Z",
     "url": "http://apidocjs.com",
     "version": "0.16.1"
   }

diff --git a/docs/api_project.json b/docs/api_project.json
@@ -8,7 +8,7 @@
   "apidoc": "0.2.0",
   "generator": {
     "name": "apidoc",
-    "time": "2016-08-18T08:43:53.081Z",
+    "time": "2016-08-18T11:02:18.340Z",
     "url": "http://apidocjs.com",
     "version": "0.16.1"
   }

diff --git a/src/Gzero/Api/Controller/Admin/BlockController.php b/src/Gzero/Api/Controller/Admin/BlockController.php
@@ -291,16 +291,18 @@ public function restore($id)
  * curl -i http://api.example.com/api/v1/admin/blocks
  */
 /**
- * @api                 {delete} /admin/blocks 6. DELETE the specified entity
+ * @api                 {delete} /admin/blocks/:id?force=:forceDelete 6. DELETE the specified entity
  * @apiVersion          0.1.0
  * @apiName             DeleteBlock
  * @apiGroup            Block
+ * @apiParam            (Content) {Number} id ID of the block.
+ * @apiParam            (Content) {Boolean} forceDelete Idicates block should be permanently deleted or not.
  * @apiPermission       admin
  * @apiDescription      Delete the specified block from database
  * @apiSuccess {Boolean} success Success flag
  *
  * @apiExample          Example usage:
- * curl -i http://api.example.com/api/v1/admin/blocks
+ * curl -i http://api.example.com/api/v1/admin/blocks/21?force=true
  * @apiSuccessExample   Success-Response:
  * HTTP/1.1 200 OK
  * {"success":true}