#167313409 Users should be able to follow each other (#20)

* rebase * feature(follow-users):Users should be able to follow each other [Finishes #167313409] * feature(follow-users):Improve follow user tests[Finishes #167313409]
andela · Aug 30, 2019 · 4f0b5e4 · 4f0b5e4
1 parent b76787a
commit 4f0b5e4
Show file tree

Hide file tree

Showing 2 changed files with 51 additions and 19 deletions.
diff --git a/src/models/follow.js b/src/models/follow.js
@@ -1,21 +1,21 @@
 'use strict';
 module.exports = (sequelize, DataTypes) => {
-  const Follow = sequelize.define('Follow', {
-    followerId: DataTypes.INTEGER,
-    followedUserId: DataTypes.INTEGER
-  }, {});
-  Follow.associate = ({ user }) => {
-    // associations can be defined here
-    Follow.belongsTo(user, {
-      foreignKey: 'followerId',
-      onDelete: 'CASCADE',
-      as: 'followerDetails'
-    });
-    Follow.belongsTo(user, {
-      foreignKey: 'followedUserId',
-      onDelete: 'CASCADE',
-      as: 'authorDetails'
-    });
-  };
-  return Follow;
-};
+      const Follow = sequelize.define('Follow', {
+            followerId: DataTypes.INTEGER,
+            followedUserId: DataTypes.INTEGER
+      }, {});
+      Follow.associate = ({ user }) => {
+            // associations can be defined here
+            Follow.belongsTo(user, {
+                  foreignKey: 'followerId',
+                  onDelete: 'CASCADE',
+                  as: 'followerDetails'
+            });
+            Follow.belongsTo(user, {
+                  foreignKey: 'followedUserId',
+                  onDelete: 'CASCADE',
+                  as: 'authorDetails'
+            });
+      };
+      return Follow;
+};
diff --git a/src/routes/api/user/doc.js b/src/routes/api/user/doc.js
@@ -138,4 +138,36 @@
  *         description: Successfully reset your password
  *       400:
  *         description: Validation error
+ * /users/profiles/{userId}/follow:
+ *   post:
+ *     description: follow user
+ *     produces:
+ *       - application/json
+ *     parameters:
+ *       - in: path
+ *         name: userId
+ *         schema:
+ *          type: integer
+ *          required: true
+ *     responses:
+ *       200:
+ *         description: You are now following
+ *       400:
+ *         description: userId must be a non negative integer
+ * /users/profiles/following:
+ *   get:
+ *     description: get all users that i follow
+ *     produces:
+ *       - application/json
+ *     responses:
+ *       200:
+ *         description: You currently do not follow anyone
+ * /users/profiles/followers:
+ *   get:
+ *     description: get all users that i follow
+ *     produces:
+ *       - application/json
+ *     responses:
+ *       200:
+ *         description: You currently do not have any followers
  */