swagger.json

{
  "swagger": "2.0",
  "info": {
    "description": "This is a RESTful API for my-brand \n[http://elvisiraguha.github.io/my-brand](http://elvisiraguha.github.io/my-brand)\n",
    "version": "1.0.0",
    "title": "My Brand",
    "contact": {
      "email": "iraguhaelvis@gmail.com"
    }
  },
  "tags": [
    {
      "name": "Articles",
      "description": "All article routes"
    },
    {
      "name": "Queries",
      "description": "Queries and messages route"
    },
    {},
    {
      "name": "Profile",
      "description": "Landing Page profile data routes"
    },
    {
      "name": "Auth",
      "description": "Operations about user"
    }
  ],
  "paths": {
    "/articles": {
      "post": {
        "tags": ["Articles"],
        "summary": "Add a new article",
        "operationId": "addArticle",
        "consumes": ["application/json"],
        "produces": ["application/json"],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "description": "A new article that needs to be added to articles collection",
            "required": true,
            "type": "object",
            "schema": {
              "$ref": "#/definitions/Article"
            }
          },
          {
            "in": "header",
            "name": "x-auth-token",
            "description": "A token for authentication",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "201": {
            "description": "Created"
          },
          "400": {
            "description": "Bad request"
          },
          "403": {
            "description": "Unauthorized"
          },
          "404": {
            "description": "Not found"
          },
          "405": {
            "description": "Invalid input"
          },
          "500": {
            "description": "Server Error"
          }
        }
      },
      "get": {
        "tags": ["Articles"],
        "summary": "Get all articles",
        "operationId": "getArticles",
        "produces": ["application/json"],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request"
          },
          "404": {
            "description": "Not found"
          },
          "500": {
            "description": "Server Error"
          }
        }
      }
    },
    "/articles/{id}": {
      "get": {
        "tags": ["Articles"],
        "summary": "Find individual article",
        "operationId": "getArticle",
        "produces": ["application/json"],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "article id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request"
          },
          "404": {
            "description": "Not found"
          },
          "500": {
            "description": "Server Error"
          }
        }
      },
      "patch": {
        "tags": ["Articles"],
        "summary": "Update article",
        "operationId": "updateArticle",
        "consumes": ["application/json"],
        "produces": ["application/json"],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "article id",
            "required": true,
            "type": "string"
          },
          {
            "in": "header",
            "name": "x-auth-token",
            "description": "a token for authentication",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "description": "Updated article contents",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Article"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request"
          },
          "404": {
            "description": "Not found"
          },
          "500": {
            "description": "Server Error"
          }
        }
      },
      "delete": {
        "tags": ["Articles"],
        "summary": "Delete individual article",
        "operationId": "deleteArticle",
        "produces": ["application/json"],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "article id",
            "required": true,
            "type": "string"
          },
          {
            "in": "header",
            "name": "x-auth-token",
            "description": "a token for authentication",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request"
          },
          "404": {
            "description": "Not found"
          },
          "500": {
            "description": "Server Error"
          }
        }
      }
    },
    "/articles/{id}/comment": {
      "post": {
        "tags": ["Articles"],
        "summary": "Post a comment",
        "operationId": "addComment",
        "produces": ["application/json"],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "article id",
            "required": true,
            "type": "string"
          },
          {
            "name": "body",
            "in": "body",
            "description": "comment body",
            "required": true,
            "type": "object",
            "schema": {
              "$ref": "#/definitions/Comment"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request"
          },
          "404": {
            "description": "Not found"
          },
          "500": {
            "description": "Server Error"
          }
        }
      }
    },
    "/queries": {
      "get": {
        "tags": ["Queries"],
        "summary": "Fetch all the queries and messages",
        "operationId": "getQueries",
        "produces": ["application/json"],
        "parameters": [
          {
            "in": "header",
            "name": "x-auth-token",
            "description": "a token for authentication",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request"
          },
          "404": {
            "description": "Not found"
          },
          "500": {
            "description": "Server Error"
          }
        }
      },
      "post": {
        "tags": ["Queries"],
        "summary": "Send a query or a message",
        "operationId": "sendQuery",
        "consumes": ["application/json"],
        "produces": ["application/json"],
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "type": "object",
            "schema": {
              "$ref": "#/definitions/Query"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request"
          },
          "500": {
            "description": "Server Error"
          }
        }
      }
    },
    "/queries/:id": {
      "patch": {
        "tags": ["Queries"],
        "summary": "Update a query read status",
        "operationId": "updateQuery",
        "consumes": ["application/json"],
        "produces": ["application/json"],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "ID of a query that needs to be updated",
            "required": true,
            "type": "string"
          },
          {
            "name": "body",
            "in": "body",
            "description": "Updated name of the pet",
            "required": true,
            "type": "object",
            "schema": {
              "$ref": "#/definitions/QueryUpdate"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request"
          },
          "404": {
            "description": "Not found"
          },
          "500": {
            "description": "Server Error"
          }
        }
      }
    },
    "/auth/signin": {
      "post": {
        "tags": ["Auth"],
        "summary": "Logs user into the system",
        "operationId": "signinUser",
        "consumes": ["application/json"],
        "produces": ["application/json"],
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "description": "The user name and password for login",
            "required": true,
            "type": "object",
            "schema": {
              "$ref": "#/definitions/Signin"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request"
          },
          "500": {
            "description": "Server Error"
          }
        }
      }
    },
    "/profile": {
      "post": {
        "tags": ["Profile"],
        "summary": "Post a profile item(skill, project, experience)",
        "operationId": "addProfileItem",
        "consumes": ["application/json"],
        "produces": ["application/json"],
        "parameters": [
          {
            "in": "header",
            "name": "x-auth-token",
            "description": "a token for authentication",
            "required": true,
            "type": "string"
          },
          {
            "in": "query",
            "name": "itemType",
            "description": "a type of item(skill, project, experience)",
            "required": true,
            "type": "string"
          },
          {
            "name": "body",
            "in": "body",
            "description": "updated contents",
            "required": true,
            "type": "object",
            "schema": {
              "$ref": "#/definitions/ProfileItem"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request"
          },
          "404": {
            "description": "Not Found"
          },
          "500": {
            "description": "Server Error"
          }
        }
      },
      "get": {
        "tags": ["Profile"],
        "summary": "Get all profile items(skills, projects, experience",
        "operationId": "getProfileItems",
        "produces": ["application/json"],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request"
          },
          "500": {
            "description": "Server Error"
          }
        }
      }
    },
    "/profile/:id": {
      "patch": {
        "tags": ["Profile"],
        "summary": "Update a profile item(skill, project, experience)",
        "operationId": "updateProfileItem",
        "consumes": ["application/json"],
        "produces": ["application/json"],
        "parameters": [
          {
            "in": "header",
            "name": "x-auth-token",
            "description": "a token for authentication",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "item id",
            "required": true,
            "type": "string"
          },
          {
            "name": "body",
            "in": "body",
            "description": "updated contents",
            "required": true,
            "type": "object",
            "schema": {
              "$ref": "#/definitions/ProfileItem"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request"
          },
          "404": {
            "description": "Not Found"
          },
          "500": {
            "description": "Server Error"
          }
        }
      },
      "delete": {
        "tags": ["Profile"],
        "summary": "Delete a profile item(skill, project, experience)",
        "operationId": "deleteProfileItem",
        "consumes": ["application/json"],
        "produces": ["application/json"],
        "parameters": [
          {
            "in": "header",
            "name": "x-auth-token",
            "description": "a token for authentication",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "id",
            "description": "item id",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request"
          },
          "404": {
            "description": "Not Found"
          },
          "500": {
            "description": "Server Error"
          }
        }
      }
    },
    "/profile/info": {
      "get": {
        "tags": ["Profile"],
        "summary": "Get all profile info(email, address, phone,...)",
        "operationId": "getProfileInfo",
        "produces": ["application/json"],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request"
          },
          "500": {
            "description": "Server Error"
          }
        }
      },
      "patch": {
        "tags": ["Profile"],
        "summary": "Get all profile items(skills, projects, experience",
        "operationId": "updateProfileInfo",
        "consumes": ["application/json"],
        "produces": ["application/json"],
        "parameters": [
          {
            "in": "header",
            "name": "x-auth-token",
            "description": "a token for authentication",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "description": "updated contents",
            "required": true,
            "type": "object",
            "schema": {
              "$ref": "#/definitions/ProfileInfo"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad request"
          },
          "500": {
            "description": "Server Error"
          }
        }
      }
    }
  },
  "definitions": {
    "Article": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string"
        },
        "content": {
          "type": "string"
        },
        "imageUlr": {
          "type": "string"
        }
      }
    },
    "Comment": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "email": {
          "type": "string"
        },
        "comment": {
          "type": "string"
        }
      }
    },
    "Query": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "email": {
          "type": "string"
        },
        "subject": {
          "type": "string"
        },
        "message": {
          "type": "string"
        }
      }
    },
    "QueryUpdate": {
      "type": "object",
      "properties": {
        "read": {
          "type": "boolean"
        }
      }
    },
    "Auth": {
      "type": "object",
      "properties": {
        "email": {
          "type": "string"
        },
        "password": {
          "type": "string"
        }
      }
    },
    "ProfileInfo": {
      "type": "object",
      "properties": {
        "email": {
          "type": "string"
        },
        "address": {
          "type": "string"
        },
        "phone": {
          "type": "string"
        },
        "title": {
          "type": "string"
        },
        "subTitle": {
          "type": "string"
        },
        "profileImageUrl": {
          "type": "string"
        },
        "intro": {
          "type": "string"
        }
      }
    },
    "ProfileItem": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "link": {
          "type": "string"
        },
        "logoUrl": {
          "type": "string"
        },
        "startDate": {
          "type": "string"
        },
        "endDate": {
          "type": "string"
        }
      }
    }
  },
  "schemes": ["https", "http"],
  "host": "my-brand.herokuapp.com",
  "basePath": "/api"
}