swagger.json

{
    "swagger": "2.0",
    "info": {
        "description": "REST endpoints for project Tyro.",
        "version": "1.0.1",
        "title": "Tyro APIs",
        "termsOfService": "",
        "contact": {
            "email": [
                "akshatdivya@infrrd.ai, akshathajanardhan@infrrd.ai"
            ]
        }
    },
    "host": "tyroapis.herokuapp.com",
    "basePath": "/",
    "tags": [
        {
            "name": "user"
        },
        {
            "name": "users"
        },
        {
            "name": "topic"
        },
        {
            "name": "topics"
        },
        {
            "name": "article"
        },
        {
            "name": "bookmarks"
        },
        {
            "name": "notification"
        }
    ],
    "schemes": [
        "https"
    ],
    "paths": {
        "/user/signup": {
            "post": {
                "tags": [
                    "user"
                ],
                "summary": "Signs user into the system",
                "description": "",
                "operationId": "userSignup",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "parameters": [
                    {
                        "in": "body",
                        "name": "body",
                        "description": "Signup User object",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/signupUser"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "successful signup",
                        "headers": {
                            "Access-Control-Allow-Origin": {
                                "type": "string",
                                "format": "string",
                                "description": "Allows CORS Requests"
                            },
                            "Authorization": {
                                "type": "string",
                                "format": "Bearer xxx.xxx.xxx",
                                "description": "JWT Auth token"
                            },
                            "Access-Control-Expose-Headers": {
                                "type": "string",
                                "format": "string",
                                "description": "Exposes Authorization header"
                            }
                        }
                    },
                    "409": {
                        "description": "Email already exists"
                    },
                    "400": {
                        "description": "Invalid Request Body"
                    },
                    "204": {
                        "description": "Empty Request Body"
                    }
                }
            }
        },
        "/user/login": {
            "post": {
                "tags": [
                    "user"
                ],
                "summary": "Logs user into the system",
                "description": "",
                "operationId": "loginUser",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "parameters": [
                    {
                        "in": "body",
                        "name": "body",
                        "description": "Login User object",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/loginUser"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "successful operation",
                        "headers": {
                            "Access-Control-Allow-Origin": {
                                "type": "string",
                                "format": "string",
                                "description": "Allows CORS Requests"
                            },
                            "Authorization": {
                                "type": "string",
                                "format": "Bearer xxx.xxx.xxx",
                                "description": "JWT Auth token"
                            },
                            "Access-Control-Expose-Headers": {
                                "type": "string",
                                "format": "string",
                                "description": "Exposes Authorization header"
                            }
                        }
                    },
                    "401": {
                        "description": "Invalid username/password supplied"
                    },
                    "204": {
                        "description": "Empty Request Body"
                    }
                }
            }
        },
        "/user/follow/{userId}": {
            "put": {
                "security": [
                    {
                        "Bearer": []
                    }
                ],
                "tags": [
                    "user"
                ],
                "summary": "Follows a user by userId(ObjectId)",
                "description": "",
                "operationId": "followUser",
                "produces": [
                    "application/json"
                ],
                "parameters": [
                    {
                        "name": "userId",
                        "in": "path",
                        "description": "userId of user to follow",
                        "required": true,
                        "type": "string"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Follow successful"
                    },
                    "400": {
                        "description": "Already following/Topic not found"
                    }
                }
            }
        },
        "/user/unfollow/{userId}": {
            "put": {
                "security": [
                    {
                        "Bearer": []
                    }
                ],
                "tags": [
                    "user"
                ],
                "summary": "Unfollows a user by userId(ObjectId)",
                "description": "",
                "operationId": "unfollowUser",
                "produces": [
                    "application/json"
                ],
                "parameters": [
                    {
                        "name": "userId",
                        "in": "path",
                        "description": "userId of user to unfollow",
                        "required": true,
                        "type": "string"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Unfollow successful"
                    },
                    "400": {
                        "description": "Topic not found"
                    }
                }
            }
        },
        "/user/upload-image": {
            "put": {
                "security": [
                    {
                        "Bearer": []
                    }
                ],
                "tags": [
                    "user"
                ],
                "summary": "Uploads/Updates the Profile Picture of the current user",
                "description": "In order to upload/update the image, the `form` should have name = `profilePic` and enctype = `multipart/form-data`",
                "operationId": "",
                "consumes": [
                    "multipart/form-data"
                ],
                "produces": [
                    "application/json"
                ],
                "parameters": [
                    {
                        "name": "profilePic",
                        "in": "formData",
                        "description": "image to be uploaded",
                        "required": true,
                        "type": "file"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "image uploaded/ image updated"
                    }
                }
            }
        },
        "/user/view-profile": {
            "get": {
                "security": [
                    {
                        "Bearer": []
                    }
                ],
                "tags": [
                    "user"
                ],
                "summary": "Get the user profile related data",
                "operationId": "viewProfile",
                "produces": [
                    "application/json"
                ],
                "parameters": [
                    {
                        "name": "userId",
                        "in": "query",
                        "description": "if userId is not provided in query then data related to logged in user will be listed",
                        "required": false,
                        "type": "string"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "successful operation",
                        "schema": {
                            "$ref": "#/definitions/viewProfileUser"
                        }
                    }
                }
            }
        },
        "/user/bio": {
            "put": {
                "security": [
                    {
                        "Bearer": []
                    }
                ],
                "tags": [
                    "user"
                ],
                "summary": "Uploads/Updates the bio of the current user",
                "operationId": "",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "parameters": [
                    {
                        "name": "Bio of the user",
                        "in": "body",
                        "required": true,
                        "schema": {
                            "type": "object",
                            "properties": {
                                "bio": {
                                    "type": "string"
                                }
                            }
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Bio updated"
                    }
                }
            }
        },
        "/users": {
            "get": {
                "security": [
                    {
                        "Bearer": []
                    }
                ],
                "tags": [
                    "users"
                ],
                "summary": "Get Users",
                "operationId": "getUsers",
                "produces": [
                    "application/json"
                ],
                "parameters": [
                    {
                        "name": "count",
                        "in": "query",
                        "description": "number of user to be listed, if count is not passed all users are returned",
                        "required": false,
                        "type": "integer"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "successful operation",
                        "schema": {
                            "type": "array",
                            "items": {
                                "$ref": "#/definitions/User"
                            }
                        }
                    }
                }
            }
        },
        "/topic/follow/{topicId}": {
            "put": {
                "security": [
                    {
                        "Bearer": []
                    }
                ],
                "tags": [
                    "topic"
                ],
                "summary": "Follows a topic by topicId(ObjectId)",
                "description": "",
                "operationId": "followTopic",
                "produces": [
                    "application/json"
                ],
                "parameters": [
                    {
                        "name": "topicId",
                        "in": "path",
                        "description": "topicId of topic to follow",
                        "required": true,
                        "type": "string"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Follow successful"
                    },
                    "400": {
                        "description": "Already following"
                    }
                }
            }
        },
        "/topic/unfollow/{topicId}": {
            "put": {
                "security": [
                    {
                        "Bearer": []
                    }
                ],
                "tags": [
                    "topic"
                ],
                "summary": "Unfollows a topic by topicId(ObjectId)",
                "description": "",
                "operationId": "unfollowTopic",
                "produces": [
                    "application/json"
                ],
                "parameters": [
                    {
                        "name": "topicId",
                        "in": "path",
                        "description": "topicId of topic to unfollow",
                        "required": true,
                        "type": "string"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Unfollow successful"
                    }
                }
            }
        },
        "/topic/autocomplete/{topicSubString}": {
            "get": {
                "security": [
                    {
                        "Bearer": []
                    }
                ],
                "tags": [
                    "topic"
                ],
                "summary": "Gets Array of topic object matching with the sub-string",
                "description": "",
                "operationId": "",
                "produces": [
                    "application/json"
                ],
                "parameters": [
                    {
                        "name": "topicSubString",
                        "in": "path",
                        "description": "topic sub-string of a particular topic",
                        "required": true,
                        "type": "string"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "successful operation",
                        "schema": {
                            "type": "array",
                            "items": {
                                "$ref": "#/definitions/Topic"
                            }
                        }
                    }
                }
            }
        },
        "/topics": {
            "get": {
                "security": [
                    {
                        "Bearer": []
                    }
                ],
                "tags": [
                    "topics"
                ],
                "summary": "Get Topics",
                "operationId": "getTopics",
                "produces": [
                    "application/json"
                ],
                "parameters": [
                    {
                        "name": "count",
                        "in": "query",
                        "description": "number of topics to be listed, if count is not passed all topics are returned",
                        "required": false,
                        "type": "integer"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "successful operation",
                        "schema": {
                            "type": "array",
                            "items": {
                                "$ref": "#/definitions/Topic"
                            }
                        }
                    }
                }
            }
        },
        "/article/createPost": {
            "post": {
                "security": [
                    {
                        "Bearer": []
                    }
                ],
                "tags": [
                    "article"
                ],
                "summary": "Adds a article to the database",
                "description": "",
                "operationId": "addArticle",
                "consumes": [
                    "application/json"
                ],
                "produces": [
                    "application/json"
                ],
                "parameters": [
                    {
                        "in": "body",
                        "name": "body",
                        "description": "Article Object",
                        "required": true,
                        "schema": {
                            "$ref": "#/definitions/Article"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Article Published"
                    },
                    "204": {
                        "description": "Empty Request Body/ Fields missing"
                    }
                }
            }
        },
        "/article/feed": {
            "get": {
                "security": [
                    {
                        "Bearer": []
                    }
                ],
                "tags": [
                    "article"
                ],
                "summary": "Returns article related to the people and topic, the user is following ",
                "description": "",
                "operationId": "feed",
                "produces": [
                    "application/json"
                ],
                "responses": {
                    "200": {
                        "description": "successful operation",
                        "schema": {
                            "type": "array",
                            "items": {
                                "$ref": "#/definitions/feedArticle"
                            }
                        }
                    }
                }
            }
        },
        "/article/trending": {
            "get": {
                "security": [
                    {
                        "Bearer": []
                    }
                ],
                "tags": [
                    "article"
                ],
                "summary": "Returns article based on number of hits",
                "description": "",
                "operationId": "trending",
                "produces": [
                    "application/json"
                ],
                "responses": {
                    "200": {
                        "description": "successful operation",
                        "schema": {
                            "type": "array",
                            "items": {
                                "$ref": "#/definitions/trendingArticle"
                            }
                        }
                    }
                }
            }
        },
        "/article/read/{articleId}": {
            "get": {
                "security": [
                    {
                        "Bearer": []
                    }
                ],
                "tags": [
                    "article"
                ],
                "summary": "Returns article by _id",
                "description": "",
                "operationId": "read",
                "produces": [
                    "application/json"
                ],
                "parameters": [
                    {
                        "name": "articleId",
                        "in": "path",
                        "description": "articleId of article to display",
                        "required": true,
                        "type": "string"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "successful operation",
                        "schema": {
                            "$ref": "#/definitions/readArticle"
                        }
                    }
                }
            }
        },
        "/article/like/{articleId}": {
            "put": {
                "security": [
                    {
                        "Bearer": []
                    }
                ],
                "tags": [
                    "article"
                ],
                "summary": "Likes a article by articleId(ObjectId)",
                "description": "",
                "operationId": "",
                "produces": [
                    "application/json"
                ],
                "parameters": [
                    {
                        "name": "articleId",
                        "in": "path",
                        "description": "articleId of article to like",
                        "required": true,
                        "type": "string"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Liked the Article"
                    },
                    "400": {
                        "description": "Already Liked/ Coudldn't find article"
                    }
                }
            }
        },
        "/article/unlike/{articleId}": {
            "put": {
                "security": [
                    {
                        "Bearer": []
                    }
                ],
                "tags": [
                    "article"
                ],
                "summary": "Unlikes a article by articleId(ObjectId)",
                "description": "",
                "operationId": "",
                "produces": [
                    "application/json"
                ],
                "parameters": [
                    {
                        "name": "articleId",
                        "in": "path",
                        "description": "articleId of article to unlike",
                        "required": true,
                        "type": "string"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Unliked this Article"
                    }
                }
            }
        },
        "/bookmarks": {
            "get": {
                "security": [
                    {
                        "Bearer": []
                    }
                ],
                "tags": [
                    "bookmarks"
                ],
                "summary": "Get Bookmarked Articles",
                "operationId": "getBookmark",
                "produces": [
                    "application/json"
                ],
                "responses": {
                    "200": {
                        "description": "successful operation",
                        "schema": {
                            "$ref": "#/definitions/bookmarkedArticle"
                        }
                    }
                }
            }
        },
        "/bookmarks/add/{articleId}": {
            "put": {
                "security": [
                    {
                        "Bearer": []
                    }
                ],
                "tags": [
                    "bookmarks"
                ],
                "summary": "Bookmarks article by articleId(ObjectId)",
                "description": "",
                "operationId": "",
                "produces": [
                    "application/json"
                ],
                "parameters": [
                    {
                        "name": "articleId",
                        "in": "path",
                        "description": "articleId of article to bookmark",
                        "required": true,
                        "type": "string"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Bookmarked this Article"
                    },
                    "400": {
                        "description": "Already bookmarked/ Couldn't find article"
                    }
                }
            }
        },
        "/bookmarks/remove/{articleId}": {
            "put": {
                "security": [
                    {
                        "Bearer": []
                    }
                ],
                "tags": [
                    "bookmarks"
                ],
                "summary": "Unbookmarks article by articleId(ObjectId)",
                "description": "",
                "operationId": "",
                "produces": [
                    "application/json"
                ],
                "parameters": [
                    {
                        "name": "articleId",
                        "in": "path",
                        "description": "articleId of article to unbookmark",
                        "required": true,
                        "type": "string"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Article is no longer bookmarked"
                    }
                }
            }
        },
        "/notifications": {
            "get": {
                "security": [
                    {
                        "Bearer": []
                    }
                ],
                "tags": [
                    "notification"
                ],
                "summary": "Get new notifications",
                "operationId": "getNotifications",
                "produces": [
                    "application/json"
                ],
                "responses": {
                    "200": {
                        "description": "Each notification in the array has the following fields:\n 1._id:id of the notification.\n2.userProfilePic:Profile picture of the author of the article.\n 3.hasSeen:status to determine if user has seen the notification.\n 4.createdOn:when someone liked the artilce/ when article was published.\n5.message: three types :\n* if someone liked the user's artilce:USERNAME liked your article, ARTICLE TITLE. \n* If a user who you are following posts an artilce:USERNAME published an article, ARTICLE TITLE. \n* If there is new article that falls under a topic you follow:There is a new article in a topic that you follow TOPIC NAME , ARTICLE NAME.",
                        "schema": {
                            "type": "array",
                            "items": {
                                "$ref": "#/definitions/notification"
                            }
                        }
                    }
                }
            }
        },
        "/notifications/clear": {
            "put": {
                "security": [
                    {
                        "Bearer": []
                    }
                ],
                "tags": [
                    "notification"
                ],
                "summary": "Delete the seen notifications",
                "description": "",
                "operationId": "",
                "produces": [
                    "application/json"
                ],
                "parameters": [
                    {
                        "name": "articleId",
                        "in": "body",
                        "description": "array of notificationId of the notifications to be deleted",
                        "required": true,
                        "type": "application/json",
                        "schema": {
                            "$ref": "#/definitions/notificationBody"
                        }
                    }
                ],
                "responses": {
                    "201": {
                        "description": "Notification Cleared"
                    },
                    "204": {
                        "description": "Empty Request Body/ Fields missing"
                    },
                    "401": {
                        "description": "unauthorized/ Notification dosen't exists"
                    }
                }
            }
        }
    },
    "securityDefinitions": {
        "Bearer": {
            "type": "apiKey",
            "name": "Authorization",
            "in": "header"
        }
    },
    "definitions": {
        "User": {
            "type": "object",
            "properties": {
                "_id": {
                    "type": "string"
                },
                "name": {
                    "type": "string"
                },
                "email": {
                    "type": "string"
                },
                "profilePic": {
                    "nullable": true,
                    "properties": {
                        "public_id": {
                            "type": "string"
                        },
                        "url": {
                            "type": "string"
                        }
                    }
                },
                "isFollowing": {
                    "type": "boolean"
                }
            },
            "xml": {
                "name": "User"
            }
        },
        "loginUser": {
            "type": "object",
            "properties": {
                "email": {
                    "type": "string"
                },
                "password": {
                    "type": "string",
                    "format": "password"
                }
            },
            "xml": {
                "name": "User"
            }
        },
        "signupUser": {
            "type": "object",
            "properties": {
                "name": {
                    "type": "string"
                },
                "email": {
                    "type": "string"
                },
                "password": {
                    "type": "string",
                    "format": "password"
                }
            },
            "xml": {
                "name": "User"
            }
        },
        "Topic": {
            "type": "object",
            "properties": {
                "_id": {
                    "type": "string"
                },
                "topicName": {
                    "type": "string"
                },
                "isFollowing": {
                    "type": "boolean"
                }
            },
            "xml": {
                "name": "Topic"
            }
        },
        "Article": {
            "type": "object",
            "properties": {
                "title": {
                    "type": "string"
                },
                "topics": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/topicId"
                    }
                },
                "content": {
                    "type": "string"
                }
            },
            "xml": {
                "name": "Article"
            }
        },
        "feedArticle": {
            "type": "object",
            "properties": {
                "_id": {
                    "type": "string"
                },
                "profilePic": {
                    "nullable": true,
                    "properties": {
                        "public_id": {
                            "type": "string"
                        },
                        "url": {
                            "type": "string"
                        }
                    }
                },
                "title": {
                    "type": "string"
                },
                "content": {
                    "type": "string"
                },
                "createdOn": {
                    "type": "string",
                    "format": "date-time"
                }
            },
            "xml": {
                "name": "feedArticle"
            }
        },
        "viewProfileUser": {
            "type": "object",
            "properties": {
                "_id": {
                    "type": "string"
                },
                "name": {
                    "type": "string"
                },
                "email": {
                    "type": "string"
                },
                "bio": {
                    "type": "string"
                },
                "profilePic": {
                    "nullable": true,
                    "properties": {
                        "url": {
                            "type": "string"
                        }
                    }
                },
                "articles": {
                    "type": "array",
                    "items": {
                        "type": "object",
                        "properties": {
                            "_id": {
                                "type": "string"
                            },
                            "title": {
                                "type": "string"
                            },
                            "content": {
                                "type": "string"
                            },
                            "createdOn": {
                                "type": "string",
                                "format": "date-time"
                            }
                        }
                    }
                }
            },
            "xml": {
                "name": "User"
            }
        },
        "trendingArticle": {
            "type": "object",
            "properties": {
                "_id": {
                    "type": "string"
                },
                "author": {
                    "$ref": "#/definitions/Author"
                },
                "title": {
                    "type": "string"
                },
                "createdOn": {
                    "type": "string",
                    "format": "date-time"
                }
            },
            "xml": {
                "name": "feedArticle"
            }
        },
        "topicId": {
            "type": "object",
            "properties": {
                "topicid": {
                    "type": "string"
                }
            }
        },
        "Author": {
            "type": "object",
            "properties": {
                "_id": {
                    "type": "string"
                },
                "profilePic": {
                    "type": "object",
                    "properties": {
                        "url": {
                            "type": "string"
                        },
                        "public_id": {
                            "type": "string"
                        }
                    }
                },
                "name": {
                    "type": "string"
                },
                "email": {
                    "type": "string"
                }
            }
        },
        "bookmarkedArticle": {
            "type": "array",
            "items": {
                "type": "object",
                "properties": {
                    "_id": {
                        "type": "string"
                    },
                    "author": {
                        "$ref": "#/definitions/Author"
                    },
                    "title": {
                        "type": "string"
                    },
                    "content": {
                        "type": "string"
                    },
                    "createdOn": {
                        "type": "string"
                    }
                }
            }
        },
        "readArticle": {
            "type": "object",
            "properties": {
                "result": {
                    "type": "object",
                    "properties": {
                        "title": {
                            "type": "string"
                        },
                        "author": {
                            "$ref": "#/definitions/readAuthor"
                        },
                        "content": {
                            "type": "string"
                        },
                        "createdOn": {
                            "type": "string",
                            "format": "date-time"
                        },
                        "hasLiked": {
                            "type": "boolean"
                        },
                        "hasBookmarked": {
                            "type": "boolean"
                        }
                    }
                }
            },
            "xml": {
                "name": "readArticle"
            }
        },
        "readAuthor": {
            "type": "object",
            "properties": {
                "_id": {
                    "type": "string"
                },
                "name": {
                    "type": "string"
                },
                "email": {
                    "type": "string"
                }
            },
            "xml": {
                "name": "readAuthor"
            }
        },
        "notification": {
            "type": "object",
            "properties": {
                "_id": {
                    "type": "string"
                },
                "userProfilePic": {
                    "type": "string"
                },
                "message": {
                    "type": "string"
                },
                "content": {
                    "type": "string"
                },
                "hasSeen": {
                    "type": "boolean"
                },
                "createdOn": {
                    "type": "string",
                    "format": "date-time"
                }
            }
        },
        "notificationBody": {
            "type": "object",
            "properties": {
                "notifications": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                }
            }
        }
    }
}