swagger.json

{
  "swagger": "2.0",
  "info": {
    "version": "3.0.3",
    "title": "Advisor Plus",
    "description": "Advisor Plus API",
    "license": {
      "name": "MIT",
      "url": "https://opensource.org/licenses/MIT"
    }
  },
  "host": "localhost:5000",
  "basePath": "/",
  "schemes": ["http"],
  "consumes": ["application/json"],
  "produces": ["application/json"],
  "paths": {
    "/post": {
      "post": {
        "tags": ["Posts"],
        "consumes": "application/json",
        "parameters": [
          {
            "in": "body",
            "name": "user",
            "schema": {
              "$ref": "#/definitions/Post"
            }
          }
        ],
        "summary": "Add a post",

        "responses": {
          "200": {
            "description": "OK",
            "content": "text"
          },
          "404": {
            "description": "ERROR",
            "content": "text"
          }
        }
      },
      "get": {
        "tags": ["Posts"],
        "parameters": [
          {
            "name": "user_id",
            "in": "query",
            "required": "true",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "summary": "Get all posts of a user",
        "responses": {
          "200": {
            "description": "OK",
            "content": "application/json",
            "schema": {
              "$ref": "#/definitions/Post"
            }
          }
        }
      }
    },
    "/post/{postId}": {
      "get": {
        "tags": ["Posts"],
        "parameters": [
          {
            "name": "postId",
            "in": "path",
            "required": "true",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "summary": "Get a post",
        "responses": {
          "200": {
            "description": "OK",
            "content": "application/json",
            "schema": {
              "$ref": "#/definitions/Post"
            }
          }
        }
      },
      "put": {
        "tags": ["Posts"],
        "parameters": [
          {
            "name": "postId",
            "in": "path",
            "required": "true",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "in": "body",
            "name": "user",
            "schema": {
              "$ref": "#/definitions/Post"
            }
          }
        ],
        "summary": "Update a post of a user",
        "responses": {
          "200": {
            "description": "OK",
            "content": "application/json",
            "schema": {
              "$ref": "#/definitions/Post"
            }
          }
        }
      },
      "delete": {
        "tags": ["Posts"],
        "parameters": [
          {
            "name": "postId",
            "in": "path",
            "required": "true",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "summary": "Delete a post of a user",
        "responses": {
          "200": {
            "description": "OK",
            "content": "application/json",
            "schema": {
              "$ref": "#/definitions/Post"
            }
          }
        }
      }
    },
    "/user_sql/{userId}": {
      "get": {
        "tags": ["User (SQL)"],
        "parameters": [
          {
            "name": "userId",
            "in": "path",
            "required": "true",
            "schema": {
              "type": "string"
            }
          }
        ],
        "summary": "Get users details in SQL database",
        "responses": {
          "200": {
            "description": "OK",
            "content": "application/json",
            "schema": {
              "$ref": "#/definitions/User (SQL)"
            }
          }
        }
      },
      "put": {
        "tags": ["User (SQL)"],
        "parameters": [
          {
            "name": "userId",
            "in": "path",
            "required": "true",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "in": "body",
            "name": "user",
            "schema": {
              "$ref": "#/definitions/User (SQL)"
            }
          }
        ],
        "summary": "Update user by Id in SQL database",
        "responses": {
          "200": {
            "description": "OK",
            "content": "application/json",
            "schema": {
              "$ref": "#/definitions/User (SQL)"
            }
          }
        }
      },
      "delete": {
        "tags": ["User (SQL)"],
        "parameters": [
          {
            "name": "userId",
            "in": "path",
            "required": "true",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "summary": "Delete user by Id in SQL database",
        "responses": {
          "200": {
            "description": "OK",
            "content": "application/json",
            "schema": {
              "$ref": "#/definitions/User (SQL)"
            }
          }
        }
      }
    },
    "/user_sql": {
      "post": {
        "tags": ["User (SQL)"],
        "consumes": "application/json",
        "parameters": [
          {
            "in": "body",
            "name": "user",
            "schema": {
              "$ref": "#/definitions/User (SQL)"
            }
          }
        ],
        "summary": "Create user in SQL database",

        "responses": {
          "200": {
            "description": "OK",
            "content": "text"
          },
          "404": {
            "description": "ERROR",
            "content": "text"
          }
        }
      }
    },
    "/advisor_profile": {
      "post": {
        "tags": ["Advisor Profile"],
        "consumes": "application/json",
        "parameters": [
          {
            "in": "body",
            "name": "advisor",
            "schema": {
              "$ref": "#/definitions/advisor_profile"
            }
          }
        ],
        "summary": "Create an advisor",

        "responses": {
          "200": {
            "description": "OK",
            "content": "text"
          },
          "404": {
            "description": "ERROR",
            "content": "text"
          }
        }
      }
    },
    "/advisor_profile/{advisorId}": {
      "get": {
        "tags": ["Advisor Profile"],
        "parameters": [
          {
            "name": "advisorId",
            "in": "path",
            "required": "true",
            "schema": {
              "type": "string"
            }
          }
        ],
        "summary": "Get details of an advisor",
        "responses": {
          "200": {
            "description": "OK",
            "content": "application/json",
            "schema": {
              "$ref": "#/definitions/advisor_profile"
            }
          }
        }
      },
      "put": {
        "tags": ["Advisor Profile"],
        "parameters": [
          {
            "name": "advisorId",
            "in": "path",
            "required": "true",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "body",
            "name": "user",
            "schema": {
              "$ref": "#/definitions/advisor_profile"
            }
          }
        ],
        "summary": "Update advisor by Id",
        "responses": {
          "200": {
            "description": "OK",
            "content": "application/json",
            "schema": {
              "$ref": "#/definitions/advisor_profile"
            }
          }
        }
      },
      "delete": {
        "tags": ["Advisor Profile"],
        "parameters": [
          {
            "name": "advisorId",
            "in": "path",
            "required": "true",
            "schema": {
              "type": "string"
            }
          }
        ],
        "summary": "Delete advisor by Id",
        "responses": {
          "200": {
            "description": "OK",
            "content": "application/json",
            "schema": {
              "$ref": "#/definitions/advisor_profile"
            }
          }
        }
      }
    },
    "/comment": {
      "post": {
        "tags": ["Comments"],
        "consumes": "application/json",
        "parameters": [
          {
            "in": "body",
            "name": "comment",
            "schema": {
              "$ref": "#/definitions/comment"
            }
          }
        ],
        "summary": "Create a comment",

        "responses": {
          "200": {
            "description": "OK",
            "content": "text"
          },
          "404": {
            "description": "ERROR",
            "content": "text"
          }
        }
      }
    },
    "/comment/{commentId}": {
      "get": {
        "tags": ["Comments"],
        "parameters": [
          {
            "name": "commentId",
            "in": "path",
            "required": "true",
            "schema": {
              "type": "string"
            }
          }
        ],
        "summary": "Get details of a comment",
        "responses": {
          "200": {
            "description": "OK",
            "content": "application/json",
            "schema": {
              "$ref": "#/definitions/comment"
            }
          }
        }
      },
      "put": {
        "tags": ["Comments"],
        "parameters": [
          {
            "name": "commentId",
            "in": "path",
            "required": "true",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "body",
            "name": "user",
            "schema": {
              "$ref": "#/definitions/comment"
            }
          }
        ],
        "summary": "Update comment by Id",
        "responses": {
          "200": {
            "description": "OK",
            "content": "application/json",
            "schema": {
              "$ref": "#/definitions/comment"
            }
          }
        }
      },
      "delete": {
        "tags": ["Comments"],
        "parameters": [
          {
            "name": "commentId",
            "in": "path",
            "required": "true",
            "schema": {
              "type": "string"
            }
          }
        ],
        "summary": "Delete comment by Id",
        "responses": {
          "200": {
            "description": "OK",
            "content": "application/json",
            "schema": {
              "$ref": "#/definitions/comment"
            }
          }
        }
      }
    },
    "/comment/{postId}": {
      "get": {
        "tags": ["Comments"],
        "parameters": [
          {
            "name": "postId",
            "in": "path",
            "required": "true",
            "schema": {
              "type": "string"
            }
          }
        ],
        "summary": "Get comments of a post",
        "responses": {
          "200": {
            "description": "OK",
            "content": "application/json",
            "schema": {
              "$ref": "#/definitions/comment"
            }
          }
        }
      }
    }
  },
  "definitions": {
    "User (SQL)": {
      "type": "object",
      "required": [
        "id",
        "name",
        "content",
        "dateOfBirth",
        "gender",
        "status",
        "imageURL",
        "createdAt",
        "updatedAt"
      ],
      "properties": {
        "id": {
          "type": "string",
          "uniqueItems": true
        },

        "name": {
          "type": "string"
        },
        "content": {
          "type": "string"
        },
        "dateOfBirth": {
          "type": "string"
        },
        "gender": {
          "type": "string",
          "enum": ["male", "female"]
        },
        "status": {
          "type": "string",
          "enum": ["blacklisted", "active", "suspended"]
        },
        "imageURL": {
          "type": "string"
        },
        "createdAt": {
          "type": "string"
        },
        "updatedAt": {
          "type": "string"
        }
      }
    },
    "Post": {
      "type": "object",
      "required": [
        "id",
        "name",
        "content",
        "dateOfBirth",
        "gender",
        "status",
        "imageURL",
        "createdAt",
        "updatedAt"
      ],
      "properties": {
        "id": {
          "type": "integer",
          "format": "int64",
          "uniqueItems": true
        },

        "user_id": {
          "type": "string"
        },
        "body": {
          "type": "string"
        },
        "uuid": {
          "type": "string"
        },
        "status": {
          "type": "string",
          "enum": ["blacklisted", "active", "suspended"]
        },
        "audience": {
          "type": "string",
          "enum": ["public", "private", "consultants"]
        },
        "service": {
          "type": "integer",
          "format": "int64"
        },
        "createdAt": {
          "type": "string"
        },
        "updatedAt": {
          "type": "string"
        }
      }
    },
    "advisor_profile": {
      "type": "object",
      "required": [
        "id",
        "name",
        "content",
        "dateOfBirth",
        "gender",
        "status",
        "imageURL",
        "createdAt",
        "updatedAt"
      ],
      "properties": {
        "id": {
          "type": "string",
          "uniqueItems": true
        },

        "name": {
          "type": "string"
        },
        "status": {
          "type": "string",
          "enum": ["blacklisted", "active", "suspended"]
        },
        "rating": {
          "type": "integer",
          "format": "int64"
        },
        "imageURL": {
          "type": "string",
          "enum": ["male", "female"]
        },
        "createdAt": {
          "type": "string"
        },
        "updatedAt": {
          "type": "string"
        }
      }
    },
    "comment": {
      "type": "object",
      "required": [
        "id",
        "post_id",
        "user_id",
        "body",
        "uuid",
        "status",
        "createdAt",
        "updatedAt"
      ],
      "properties": {
        "id": {
          "type": "integer",
          "format": "int64",
          "uniqueItems": true
        },
        "post_id": {
          "type": "integer",
          "format": "int64"
        },
        "user_id": {
          "type": "string"
        },
        "body": {
          "type": "string"
        },
        "uuid": {
          "type": "string"
        },
        "rating": {
          "type": "integer",
          "format": "int64"
        },

        "createdAt": {
          "type": "string"
        },
        "updatedAt": {
          "type": "string"
        }
      }
    }
  }
}