Kaynağa Gözat

create documentation for the login route.

Lee Morgan 1 yıl önce
ebeveyn
işleme
4661213fb3
2 değiştirilmiş dosya ile 31 ekleme ve 2 silme
  1. 1 1
      controllers/user.js
  2. 30 1
      documentation/data.js

+ 1 - 1
controllers/user.js

@@ -10,7 +10,7 @@ const createRoute = async (req, res, next)=>{
         validate(req.body);
         const user = await createUser(req.body);
         await user.save();
-        res.json(responseUser(user));
+        res.json({success: true});
     }catch(e){next(e)}
 }
 

+ 30 - 1
documentation/data.js

@@ -61,6 +61,35 @@ window.data = [
                 type: "String",
                 desc: "Confirmation password"
             }
-        ]
+        ],
+        responseBody: [{
+            name: "success",
+            type: "true",
+            desc: "Always '{success: true} if no error'"
+        }]
+    },
+    {
+        type: "route",
+        id: "loginUser",
+        title: "Log In",
+        url: "PUT /user/login",
+        description: "Log the user in",
+        requestBody: [
+            {
+                name: "email",
+                type: "String",
+                desc: "User email address"
+            },
+            {
+                name: "pass",
+                type: "String",
+                desc: "User password"
+            }
+        ],
+        responseBody: [{
+            name: "N/A",
+            type: "User",
+            desc: "User object"
+        }]
     }
 ]