From e9a2da4bd8e439de2be43909e36e9f693801fe74 Mon Sep 17 00:00:00 2001
From: sundowndev <raphael@crvx.fr>
Date: Fri, 16 Nov 2018 12:28:58 +0100
Subject: [PATCH] API Docs

---
 docs/api_data.js      | 69 +++++++++++++++++++++++++++++++++++++++----
 docs/api_data.json    | 69 +++++++++++++++++++++++++++++++++++++++----
 docs/api_project.js   |  2 +-
 docs/api_project.json |  2 +-
 4 files changed, 128 insertions(+), 14 deletions(-)

diff --git a/docs/api_data.js b/docs/api_data.js
index e884f89..53600a1 100644
--- a/docs/api_data.js
+++ b/docs/api_data.js
@@ -12,8 +12,8 @@ define({ "api": [
             "group": "Parameter",
             "type": "String",
             "optional": false,
-            "field": "username",
-            "description": "<p>username of the user.</p>"
+            "field": "email",
+            "description": "<p>email of the user.</p>"
           },
           {
             "group": "Parameter",
@@ -69,8 +69,8 @@ define({ "api": [
             "group": "Parameter",
             "type": "String",
             "optional": false,
-            "field": "username",
-            "description": "<p>username of the user.</p>"
+            "field": "email",
+            "description": "<p>email of the user.</p>"
           },
           {
             "group": "Parameter",
@@ -99,6 +99,36 @@ define({ "api": [
     "filename": "app/routes/auth/index.js",
     "groupTitle": "Auth"
   },
+  {
+    "type": "post",
+    "url": "/auth/reset-password",
+    "title": "Reset password",
+    "name": "ResetPass",
+    "group": "Auth",
+    "parameter": {
+      "fields": {
+        "Parameter": [
+          {
+            "group": "Parameter",
+            "type": "String",
+            "optional": false,
+            "field": "email",
+            "description": "<p>email of the user.</p>"
+          },
+          {
+            "group": "Parameter",
+            "type": "String",
+            "optional": false,
+            "field": "password",
+            "description": "<p>password of the user.</p>"
+          }
+        ]
+      }
+    },
+    "version": "0.0.0",
+    "filename": "app/routes/auth/index.js",
+    "groupTitle": "Auth"
+  },
   {
     "type": "post",
     "url": "/note",
@@ -157,7 +187,7 @@ define({ "api": [
       "examples": [
         {
           "title": "Error-Response:",
-          "content": "HTTP/1.1 403 Not Found\n{\n  \"success\": false,\n  \"message\": \"Access forbidden.\",\n  \"errors\": []\n}",
+          "content": "HTTP/1.1 403 Forbidden\n{\n  \"success\": false,\n  \"message\": \"Access forbidden.\",\n  \"errors\": []\n}",
           "type": "json"
         }
       ]
@@ -278,7 +308,7 @@ define({ "api": [
   {
     "type": "get",
     "url": "/user/me",
-    "title": "Get user information",
+    "title": "Get account information",
     "name": "GetUser",
     "group": "User",
     "success": {
@@ -318,6 +348,33 @@ define({ "api": [
     "title": "Update account information",
     "name": "UpdateUser",
     "group": "User",
+    "parameter": {
+      "fields": {
+        "Parameter": [
+          {
+            "group": "Parameter",
+            "type": "String",
+            "optional": false,
+            "field": "Firstname",
+            "description": "<p>new firstname.</p>"
+          },
+          {
+            "group": "Parameter",
+            "type": "String",
+            "optional": false,
+            "field": "Lastname",
+            "description": "<p>new lastname.</p>"
+          },
+          {
+            "group": "Parameter",
+            "type": "String",
+            "optional": false,
+            "field": "Email",
+            "description": "<p>new email address.</p>"
+          }
+        ]
+      }
+    },
     "success": {
       "fields": {
         "Success 200": [
diff --git a/docs/api_data.json b/docs/api_data.json
index 16d22ec..4ee18b9 100644
--- a/docs/api_data.json
+++ b/docs/api_data.json
@@ -12,8 +12,8 @@
             "group": "Parameter",
             "type": "String",
             "optional": false,
-            "field": "username",
-            "description": "<p>username of the user.</p>"
+            "field": "email",
+            "description": "<p>email of the user.</p>"
           },
           {
             "group": "Parameter",
@@ -69,8 +69,8 @@
             "group": "Parameter",
             "type": "String",
             "optional": false,
-            "field": "username",
-            "description": "<p>username of the user.</p>"
+            "field": "email",
+            "description": "<p>email of the user.</p>"
           },
           {
             "group": "Parameter",
@@ -99,6 +99,36 @@
     "filename": "app/routes/auth/index.js",
     "groupTitle": "Auth"
   },
+  {
+    "type": "post",
+    "url": "/auth/reset-password",
+    "title": "Reset password",
+    "name": "ResetPass",
+    "group": "Auth",
+    "parameter": {
+      "fields": {
+        "Parameter": [
+          {
+            "group": "Parameter",
+            "type": "String",
+            "optional": false,
+            "field": "email",
+            "description": "<p>email of the user.</p>"
+          },
+          {
+            "group": "Parameter",
+            "type": "String",
+            "optional": false,
+            "field": "password",
+            "description": "<p>password of the user.</p>"
+          }
+        ]
+      }
+    },
+    "version": "0.0.0",
+    "filename": "app/routes/auth/index.js",
+    "groupTitle": "Auth"
+  },
   {
     "type": "post",
     "url": "/note",
@@ -157,7 +187,7 @@
       "examples": [
         {
           "title": "Error-Response:",
-          "content": "HTTP/1.1 403 Not Found\n{\n  \"success\": false,\n  \"message\": \"Access forbidden.\",\n  \"errors\": []\n}",
+          "content": "HTTP/1.1 403 Forbidden\n{\n  \"success\": false,\n  \"message\": \"Access forbidden.\",\n  \"errors\": []\n}",
           "type": "json"
         }
       ]
@@ -278,7 +308,7 @@
   {
     "type": "get",
     "url": "/user/me",
-    "title": "Get user information",
+    "title": "Get account information",
     "name": "GetUser",
     "group": "User",
     "success": {
@@ -318,6 +348,33 @@
     "title": "Update account information",
     "name": "UpdateUser",
     "group": "User",
+    "parameter": {
+      "fields": {
+        "Parameter": [
+          {
+            "group": "Parameter",
+            "type": "String",
+            "optional": false,
+            "field": "Firstname",
+            "description": "<p>new firstname.</p>"
+          },
+          {
+            "group": "Parameter",
+            "type": "String",
+            "optional": false,
+            "field": "Lastname",
+            "description": "<p>new lastname.</p>"
+          },
+          {
+            "group": "Parameter",
+            "type": "String",
+            "optional": false,
+            "field": "Email",
+            "description": "<p>new email address.</p>"
+          }
+        ]
+      }
+    },
     "success": {
       "fields": {
         "Success 200": [
diff --git a/docs/api_project.js b/docs/api_project.js
index c53faf1..3f62ab3 100644
--- a/docs/api_project.js
+++ b/docs/api_project.js
@@ -8,7 +8,7 @@ define({
   "apidoc": "0.3.0",
   "generator": {
     "name": "apidoc",
-    "time": "2018-11-15T18:00:50.902Z",
+    "time": "2018-11-16T10:11:39.561Z",
     "url": "http://apidocjs.com",
     "version": "0.17.7"
   }
diff --git a/docs/api_project.json b/docs/api_project.json
index 4af392b..bf2c8b6 100644
--- a/docs/api_project.json
+++ b/docs/api_project.json
@@ -8,7 +8,7 @@
   "apidoc": "0.3.0",
   "generator": {
     "name": "apidoc",
-    "time": "2018-11-15T18:00:50.902Z",
+    "time": "2018-11-16T10:11:39.561Z",
     "url": "http://apidocjs.com",
     "version": "0.17.7"
   }