swagger.yaml

swagger: '2.0'
info:
  description: This is the API documentation for the COP 4331 Marketplace App. Made by Jeovan Teixeira, Ethan Fluhr, and Remi Roper.
  version: 1.0.0
  title: Marketplace App
  contact:
    email: je127364@ucf.edu

  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html

paths:
  /login:
    post:
      tags:
      - Users
      summary: Logs in to the marketplace app
      operationId: dlLogin
      description: Logs in to the marketplace app, returns empty info with an error string saying if it worked or not
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: body
        name: loginUser
        description: Login
        schema:
          $ref: '#/definitions/Login'
      responses:
        "Empty Error String":
          description: OK
          schema: 
            $ref: '#/definitions/LoginResponse'
        "No Records Found":
          description: Login couldn't find the user in the Users table with their login and password
  /register:
    post:
      tags:
      - Users
      summary: Regisers new users in to the marketplace app
      operationId: dlRegister
      description: Registers in to the marketplace app, returns new user ID and an error string saying if it worked or not
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: body
        name: registerUser
        description: Register
        schema:
          $ref: '#/definitions/Register'
      responses:
        "Empty Error String":
          description: OK
          schema:
            $ref: '#/definitions/RegisterResponse'
        "User Already Exists":
          description: Duplicate User has been Found
  /emailVerify:
    post:
      tags:
      - Server
      summary: Checks if the user can verify their email or not
      operationId: dlVerifyEmail
      description: Takes in the user's id and verification number. If it matches the verification number in the database and was verified in time then they will be marked as verified. If not return an error.
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: body
        name: verifyEmail
        description: Email
        schema:
          $ref: '#/definitions/EmailVerify'
      responses:
        "User Id Not Found":
          description: The given id was not found in the database
        "User is already verified":
          description: The user has been verified before
        "User didn't verify in time":
          description: The user verified their account too late
        "Incorrect Verification Number":
          description: The given verification number did not match the database
        "Undefined Behavior Spotted":
          description: A database issue was encountered
        "Empty Error String":
          description: OK
          schema:
            $ref: '#/definitions/EmailVerifyResponse'
  /editUser:
    post:
      tags:
      - Users
      summary: Edits the user's account info with given fields
      operationId: dlEditUser
      description: Takes in the user's unique identifier and edit's their database document with given input fields. If the input field is empty, the database will not change that field.
      consumes:
      - multipart/form-data
      produces:
      - application/json
      parameters:
      - in: formData
        name: id
        type: string
      - in: formData
        name: firstName
        type: string
      - in: formData
        name: lastName
        type: string
      - in: formData
        name: username
        type: string
      - in: formData
        name: password
        type: string
      - in: formData
        name: email
        type: string
      - in: formData
        name: phoneNumber
        type: string
      - in: formData
        name: aboutMe
        type: string
      - in: formData
        name: image
        type: file
      responses:
        "Empty Error String":
          description: OK
          schema:
            $ref: '#/definitions/LoginResponse'
        "Non-Empty Error String":
          description: An error occured with updating the user
  /createPost:
    post:
      tags:
      - Posts
      summary: Creates a new post to show in the marketplace app
      operationId: dlCreatePost
      description: Creates a new post and puts it into the database, returns id of post and error string
      consumes:
      - multipart/form-data
      produces:
      - application/json
      parameters:
      - in: formData
        name: username
        type: string
      - in: formData
        name: name
        type: string
      - in: formData
        name: genre
        type: string
      - in: formData
        name: price
        type: number
      - in: formData
        name: desc
        type: string
      - in: formData
        name: condition
        type: string
      - in: formData
        name: image
        type: file
      responses:
        "Empty Error String":
          description: OK
          schema:
            $ref: '#/definitions/NormalResponse'
        "Post already exists":
          description: Duplicate post has been found
  /editPost:
    post:
      tags:
      - Posts
      summary: Edits the user's post with given fields
      operationId: dlEditPost
      description: Takes in the new post details and edits the post at the given id in the database. If the input field is empty, the database will not change that field.
      consumes:
      - multipart/form-data
      produces:
      - application/json
      parameters:
      - in: formData
        name: id
        type: string
      - in: formData
        name: username
        type: string
      - in: formData
        name: name
        type: string
      - in: formData
        name: genre
        type: string
      - in: formData
        name: price
        type: number
      - in: formData
        name: desc
        type: string
      - in: formData
        name: condition
        type: string
      - in: formData
        name: image
        type: file
      responses:
        "Empty Error String":
          description: OK
          schema:
            $ref: '#/definitions/NormalResponse'
        "Non-Empty Error String":
          description: An error occured with updating the post
  /searchPost:
    post:
      tags:
      - Posts
      summary: Searches the database for posts given certain input
      operationId: dlsearchPost
      description: Place search terms in their respective fields and get back an array that matches the search terms sent. To limit the amount of search results use minIndex and maxIndex to limit the resulting array. minIndex and maxIndex are not required to make the post request work.
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: body
        name: searchPost
        description: search
        schema:
          $ref: '#/definitions/SearchPost'
      responses:
        "Empty Error String":
          description: OK
          schema:
            $ref: '#/definitions/SearchPostResponse'
        "Too many used fields":
          description: Input format was incorrect. Two fields must be blank.
  /noRegexSearchPost:
    post:
      tags:
      - Posts
      summary: Searches the database for posts given certain input without the use of regex
      operationId: dlsearchPost
      description: Place search terms in their respective fields and get back an array that matches the search terms sent. To limit the amount of search results use minIndex and maxIndex to limit the resulting array. minIndex and maxIndex are not required to make the post request work.
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: body
        name: searchPost
        description: search
        schema:
          $ref: '#/definitions/SearchPost'
      responses:
        "Empty Error String":
          description: OK
          schema:
            $ref: '#/definitions/SearchPostResponse'
        "Too many used fields":
          description: Input format was incorrect. Two fields must be blank.
  /searchPostPaged:
    post:
      tags:
      - Posts
      summary: Searches the database for posts given certain input and given pagination indexes
      operationId: dlsearchPost
      description: Place search terms in their respective fields and get back an array that matches the search terms sent. To limit the amount of search results use minIndex and maxIndex to limit the resulting array. minIndex and maxIndex are not required to make the post request work.
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: body
        name: searchPost
        description: search
        schema:
          $ref: '#/definitions/SearchPostPaged'
      responses:
        "Empty Error String":
          description: OK
          schema:
            $ref: '#/definitions/SearchPostResponse'
        "Non-empty error string":
          description: There was an error with the database.
  /deletePost:
    post:
      tags:
      - Posts
      summary: Deletes a certain post
      operationId: dldeletePost
      description: Takes in the info of a post and deletes it off the database.
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: body
        name: deletePost
        description: deleting
        schema:
          $ref: '#/definitions/DeletePost'
      responses:
        "Empty Error String":
          description: OK
          schema:
            $ref: '#/definitions/NormalResponse'
        "Post was not found":
          description: Database wasn't able to find the post
  /interestAddition:
    post:
      tags:
      - Posts
      summary: Adds the user to the interests section for the given post
      operationId: dlInterest
      description: Takes in the post id and user id and adjusts the database to show that the user is interested
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: body
        name: interest
        description: Editing Interest
        schema:
          $ref: '#/definitions/InterestAddition'
      responses:
        "Empty Error String":
          description: OK
          schema:
            $ref: '#/definitions/ErrorOnlyResponse'
        "Non-Empty Error String":
          description: An error occured with updating the database
  /interestDeletion:
    post:
      tags:
      - Posts
      summary: Deletes the user to the interests section for the given post
      operationId: dlInterestDelete
      description: Takes in the post id and user id and adjusts the database to show that the user is uninterested
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: body
        name: interest
        description: Editing Interest
        schema:
          $ref: '#/definitions/InterestAddition'
      responses:
        "Empty Error String":
          description: OK
          schema:
            $ref: '#/definitions/ErrorOnlyResponse'
        "Non-Empty Error String":
          description: An error occured with updating the database
  /getUser:
    post:
      tags:
      - Users
      summary: Get user object
      operationId: dlGetUser
      description: When given an id, return the user object associated with that id. The boolean value in the input field "justUsername" will determine whether you receive just the username or the whole user document.
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: body
        name: GetUser
        description: Returns user objects
        schema:
          $ref: '#/definitions/GetUser'
      responses:
        "Empty Error String":
          description: OK
        "User was not found":
          description: The given user was not found
  /getPost:
    post:
      tags:
      - Posts
      summary: Get post object
      operationId: dlGetPost
      description: When given an id, return the post object associated with that id
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: body
        name: GetPost
        description: Returns user objects
        schema:
          $ref: '#/definitions/GetPost'
      responses:
        "Empty Error String":
          description: OK
        "Post was not found":
          description: The given user was not found
  /passwordRequest:
    post:
      tags:
      - Server
      summary: Aid in password recovery
      operationId: dlpasswordRequest
      description: Takes in the username of the user and searches the database for them. If they exists then grab their email and send them a verification code to verify it is them. While that happens update the DB to have this verification code.
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: body
        name: Password Request
        description: Aid in password recovery
        schema:
          $ref: '#/definitions/PasswordRequest'
      responses:
        "Empty Error String":
          description: OK
          schema:
            $ref: '#/definitions/PasswordRequestResponse'
        "User is not in Database":
          description: The given user was not found
  /passwordChange:
    post:
      tags:
      - Server
      summary: Changes the password of a given user
      operationId: dlpasswordChange
      description: Takes in the username of the user, verification number, and the new password. It checks the DB to see if the verification number is correct. If so change the user's password.
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: body
        name: Password Change
        description: Changes the password of a given user
        schema:
          $ref: '#/definitions/PasswordChange'
      responses:
        "Empty Error String":
          description: OK
          schema:
            $ref: '#/definitions/LoginResponse'
        "User is not in Database":
          description: The given user was not found
        "Verify Num doesn't match Database":
          description: The given verification number was different from the database
  /searchUser:
    post:
      tags:
      - Users
      summary: Searches for a user
      operationId: dlsearhUser
      description: Searches a user via their username
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: body
        name: Password Change
        description: Changes the password of a given user
        schema:
          $ref: '#/definitions/SearchUser'
      responses:
        "Empty Error String":
          description: OK
        "Non-Empty Error String":
          description: There was an error with the database when searching for the users
parameters:
  id:
    in: formData
    name: id
    type: string
  username:
    in: formData
    name: username
    type: string
  password:
    in: formData
    name: password
    type: string
  email:
    in: formData
    name: email
    type: string
  phoneNumber:
    in: formData
    name: phoneNumber
    type: string
  aboutMe:
    in: formData
    name: aboutMe
    type: string
  firstName:
    in: formData
    name: firstName
    type: string
  lastName:
    in: formData
    name: lastName
    type: string
  name:
    in: formData
    name: name
    type: string
  genre:
    in: formData
    name: genre
    type: string
  price:
    in: formData
    name: prices
    type: number
  desc:
    in: formData
    name: desc
    type: string
  condition:
    in: formData
    name: condition
    type: string
  image:
    in: formData
    name: image
    type: file

definitions:
  NormalResponse:
    type: object
    properties:
      _id:
        type: string
        example: 12121fafwfaf103012
      error:
        type: string
        example: ""
  ErrorOnlyResponse:
    type: object
    properties:
      error:
        type: string
        example: ""
  GetUser:
    type: object
    required:
    - userId
    properties:
      userId:
        type: string
        example: 12121fafwfaf103012
      justUsername: 
        type: number
        example: 0
  GetPost:
    type: object
    required:
    - Post ID
    properties:
      postId:
        type: string
        example: 12121fafwfaf103012
  Login:
    type: object
    required:
    - Login
    - Password
    properties:
      username:
        type: string
        example: fred
      password:
        type: string
        example: secret
  LoginResponse:
    type: object
    properties:
      id:
        type: string
        example: 12121fafwfaf103012
      firstName:
        type: string
        example: Fred
      lastName:
        type: string
        example: Doe
      username:
        type: string
        example: Fred1212
      email:
        type: string
        example: fred@doe.com
      phoneNumber:
        type: string
        example: 1112223333
      aboutMe:
        type: string
        example: About Me
      profilePic:
        type: object
      ttl:
        type: number
        example: 12121213454
      interestedIn:
        type: string
        example: []
      error:
        type: string
        example: ""
  Register:
    type: object
    required:
    - First Name
    - Last Name
    - Username
    - Password
    - Email
    - Phone Number
    properties:
      firstname:
        type: string
        example: Fred
      lastname:
        type: string
        example: Doe
      username:
        type: string
        example: fred111
      password:
        type: string
        example: secret
      email:
        type: string
        example: fred@fred.com
      phoneNumber:
        type: string
        example: 4079981234
  RegisterResponse:
    type: object
    properties:
      _id:
        type: string
        example: 12121fafwfaf103012
      firstName:
        type: string
        example: Fred
      lastName:
        type: string
        example: Doe
      username:
        type: string
        example: Fred1212
      email:
        type: string
        example: fred@doe.com
      phoneNumber:
        type: string
        example: 1112223333
      aboutMe:
        type: string
        example: About Me
      profilePic:
        type: object
      ttl:
        type: number
        example: 12121213454
      interestedIn:
        type: string
        example: []
      error:
        type: string
        example: ""
  EmailVerify:
    type: object
    required:
    - id
    - Verification Number
    properties:
      id:
        type: string
        example: 12121fafwfaf103012
      verifyNum:
        type: integer
        example: 458792
  EmailVerifyResponse:
    type: object
    properties:
      id:
        type: string
        example: 12121fafwfaf103012
      ttl:
        type: number
        example: 12345593473
      error:
        type: string
        example: ''
  InterestAddition:
    type: object
    required:
    - User ID
    - Post ID
    properties:
      userId:
        type: string
        example: 12121fafwfaf103012
      postId:
        type: string
        example: 1313131fwasdwad131
  SearchPost:
    type: object
    required:
    - Username
    - Name of Post
    - Genre
    properties:
      username:
        type: string
        example: Fred121
      name:
        type: string
        example: Fred
      genre: 
        type: string
        example: Cars
  SearchPostPaged:
    type: object
    required:
    - Username
    - Name of Post
    - Genre
    - limit
    - skip
    properties:
      username:
        type: string
        example: Fred121
      name:
        type: string
        example: Fred
      genre: 
        type: string
        example: Cars
      limit:
        type: number
        example: 10
      skip:
        type: number
        example: 1
  SearchPostResponse:
    type: object
    properties:
      results: 
        type: array
        items:
          type: object
          properties:
            _id:
              type: string
              example: 1313131fwasdwad131
            username: 
              type: string
              example: Fred121
            name:
              type: string
              example: Fred
            genre:
              type: string
              example: Cars
            price:
              type: number
              example: 22.49
            desc: 
              type: string
              example: Description
            condition:
              type: string
              example: Good
      error:
        type: string
        example: ""
  DeletePost:
    type: object
    required:
    - Id
    properties:
      id:
        type: string
        example: 1313131fwasdwad131
  PasswordRequest:
    type: object
    required:
    - username
    properties:
      username:
        type: string
        example: Fred121
  PasswordRequestResponse:
    type: object
    properties:
      username:
        type: string
        example: Fred121
      email: 
        type: string
        example: fred@fred.com
      verifyNum:
        type: number
        example: 12345
      error: 
        type: string
        example: ''
  PasswordChange:
    type: object
    required:
    - username
    - verifyNum
    - newPassword
    properties:
      username:
        type: string
        example: Fred121
      verifyNum:
        type: number
        example: 12345
      newPassword:
        type: string
        example: secret
  SearchUser:
    type: object
    required:
    - username
    properties:
      username:
        type: string
        example: Fred121

host: cop4331-marketplace-98e1376d9db6.herokuapp.com
basePath: /api
schemes:
- https