API-Documentation.yaml

swagger: '2.0'
info:
  title: X-Clone APIs
  version: 1.0.0
  description: API documentation for X-Clone project. `Hint =  for frontend, the browser will set the cookies for you, so i didn't write it in the request parameters. for flutter, you can sent the token as Bearer token`. the api url format is 'protocol://theHOST/api/v[0-9]+/api-path-in-each-one}', examble on first api -suggest localhost- => `'http://localhost:1444/api/v1/auth/signup'`
tags:
  - name: auth
    description: Authentication Endpoints
  - name: profile
    description: User Personal Data Endpoints
  - name: user interactions
    description: User Interactions Endpoints
  - name: tweets
    description: Operations related to tweets.
  - name: timeline
    description: Operations related to timeline.
  - name: trends
    description: Operations related to trends.
  - name: search
    # description: .
paths:
  /auth/signup:
    post:
      tags:
        - auth
      summary: Sign up to the application
      description: Endpoint for user registeration on the application. `sitekey is for reCAPTCHA "6LeousYoAAAAACH0uCm7e4NKQkOWgrZWxmPPCMBZ"`
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: body
          in: body
          description: User credentials for authentication
          required: true
          schema:
            type: object
            properties:
              name:
                type: string
                description: The name of the user for sign up
              username:
                type: string
                description: The username of the user for sign up
              email:
                type: string
                description: The email for sign up
              password:
                type: string
                description: The password for sign up
              passwordConfirm:
                type: string
                description: confirm the password
              dateOfBirth:
                type: string
                format: date
                description: The password for signup
              gRecaptchaResponse:
                type: string
                description: >-
                  g-recaptcha-response is the name of response key or sitekey to
                  check "I'm not a robot" using google reCAPTCHA
      responses:
        '201':
          description: Successful sign-up
          schema:
            type: object
            properties:
              status:
                type: boolean
              data:
                type: object
                properties:
                  token:
                    type: string
                  user:
                    type: object
                    properties:
                      id:
                        type: bigint
                      isConfirmed:
                        type: boolean
                      username:
                        type: string
                      email:
                        type: string
                      createdAt:
                        type: string
                      followersCount:
                        type: string
                      followingsCount:
                        type: string
                      bannerUrl:
                        type: string
                      bio:
                        type: string
                      location:
                        type: string
                      website:
                        type: string
                      birthDate:
                        type: string
                      imageUrl:
                        type: string
                      name:
                        type: string
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Something went wrong
  /auth/signin:
    post:
      tags:
        - auth
      summary: Sign in to the application
      description: Endpoint for user authentication and obtaining an access token.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: body
          in: body
          description: User credentials for authentication
          required: true
          schema:
            type: object
            properties:
              email:
                type: string
                description: The email for login
              password:
                type: string
                description: The password for login
      responses:
        '200':
          description: Successful sign-in
          headers:
            Set-Cookie:
              type: string
              description: Cookie containing the access token
          schema:
            type: object
            properties:
              status:
                type: boolean
              data:
                type: object
                properties:
                  token:
                    type: string
                  user:
                    type: object
                    properties:
                      id:
                        type: bigint
                      isConfirmed:
                        type: boolean
                      username:
                        type: string
                      email:
                        type: string
                      createdAt:
                        type: string
                      followersCount:
                        type: string
                      followingsCount:
                        type: string
                      bannerUrl:
                        type: string
                      bio:
                        type: string
                      location:
                        type: string
                      website:
                        type: string
                      birthDate:
                        type: string
                      imageUrl:
                        type: string
                      name:
                        type: string
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Something went wrong
  /auth/signWithGoogle:
    post:
      tags:
        - auth
      summary: Sign in/up to the application with google automatically
      description: Endpoint for user authentication using google.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: body
          in: body
          description: User credentials for authentication
          required: true
          schema:
            type: object
            properties:
              googleAccessToken:
                type: string
      responses:
        '200':
          description: Successful sign-in
          headers:
            Set-Cookie:
              type: string
              description: Cookie containing the access token
          schema:
            type: object
            properties:
              status:
                type: boolean
              data:
                type: object
                properties:
                  token:
                    type: string
                  user:
                    type: object
                    properties:
                      userId:
                        type: bigint
                      isConfirmed:
                        type: boolean
                      username:
                        type: string
                      email:
                        type: string
                      createdAt:
                        type: string
                      followersCount:
                        type: string
                      followingsCount:
                        type: string
                      bannerUrl:
                        type: string
                      bio:
                        type: string
                      location:
                        type: string
                      website:
                        type: string
                      birthDate:
                        type: string
                      imageUrl:
                        type: string
                      name:
                        type: string
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Something went wrong
  /auth/me:
    post:
      tags:
        - auth
      summary: Get Me
      consumes:
        - application/json
      produces:
        - application/json
      responses:
        '200':
          description: Successful get me
          schema:
            type: object
            properties:
              status:
                type: boolean
              data:
                type: object
                properties:
                  token:
                    type: string
                  user:
                    type: object
                    properties:
                      id:
                        type: bigint
                      isConfirmed:
                        type: boolean
                      username:
                        type: string
                      email:
                        type: string
                      createdAt:
                        type: string
                      followersCount:
                        type: string
                      followingsCount:
                        type: string
                      bannerUrl:
                        type: string
                      bio:
                        type: string
                      location:
                        type: string
                      website:
                        type: string
                      birthDate:
                        type: string
                      imageUrl:
                        type: string
                      name:
                        type: string
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Something went wrong
  /auth/signout:
    delete:
      tags:
        - auth
      summary: Sign out from the application
      description: Endpoint to delete the token from cookies.
      consumes:
        - application/json
      produces:
        - application/json
      responses:
        '200':
          description: Successful sign-in
          headers:
            Set-Cookie:
              type: string
              description: Cookie containing loggedout expires after 5s
          schema:
            type: object
            properties:
              status:
                type: boolean
              data:
                type: object
                properties:
                  token:
                    type: string
                    example: loggedout
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Something went wrong
  /auth/resendConfirmEmail:
    post:
      tags:
        - auth
      summary: Resend the confirmation email to the user
      description: Endpoint to send email confirmation.
      consumes:
        - application/json
      produces:
        - application/json
      responses:
        '200':
          description: Successful Sending a Confirm-Email
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: true
              message: A new OTP was sent to the user
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Something went wrong
        '401':
          description: Unauthorized - Should be authorized to complete the request
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Unauthorized user
  /auth/verifyEmail:
    post:
      tags:
        - auth
      summary: Confirm the email of the user
      description: Endpoint for user email confirmation by the otp sent to the email.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: body
          in: body
          description: OTP 8 bit number sent in the email
          required: true
          schema:
            type: object
            properties:
              otp:
                type: string
                description: the number sent in the verification email
      responses:
        '200':
          description: Successful sign-in
          headers:
            Set-Cookie:
              type: string
              description: Cookie containing the access token
          schema:
            type: object
            properties:
              status:
                type: boolean
              data:
                type: object
                properties:
                  token:
                    type: string
                  user:
                    type: object
                    properties:
                      userId:
                        type: bigint
                      isConfirmed:
                        type: boolean
                      username:
                        type: string
                      email:
                        type: string
                      createdAt:
                        type: string
                      followersCount:
                        type: string
                      followingsCount:
                        type: string
                      bannerUrl:
                        type: string
                      bio:
                        type: string
                      location:
                        type: string
                      website:
                        type: string
                      birthDate:
                        type: string
                      imageUrl:
                        type: string
                      name:
                        type: string
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Something went wrong
        '401':
          description: Unauthorized -Invalid email or the otp expired
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Unauthorized user
  /auth/updatePassword:
    patch:
      tags:
        - auth
      summary: Update the user password
      description: Endpoint for user password changing.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: body
          in: body
          description: User new password for authentication
          required: true
          schema:
            type: object
            properties:
              currentPassword:
                type: string
                description: current password of the user
              newPassword:
                type: string
              newPasswordConfirm:
                type: string
      responses:
        '200':
          description: Successful sign-up
          headers:
            Set-Cookie:
              type: string
              description: Cookie containing the access token.
          schema:
            type: object
            properties:
              status:
                type: boolean
              data:
                type: object
                properties:
                  token:
                    type: string
                  user:
                    type: object
                    properties:
                      id:
                        type: bigint
                      name:
                        type: string
                      username:
                        type: string
                      email:
                        type: string
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Something went wrong
        '401':
          description: Unauthorized - Should be authorized to complete the request
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Unauthorized user
  /auth/forgetPassword:
    post:
      tags:
        - auth
      summary: Send an email requesting change password
      description: >-
        Endpoint that take the email of the user and send an email with a
        One-Time url - has a token to authorize - to change the password, this
        url expires after 10m.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: body
          in: body
          description: User credentials for authentication
          required: true
          schema:
            type: object
            properties:
              email:
                type: string
      responses:
        '200':
          description: Successful Sending a Password Change Email
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: true
              message: email sent successfully, check it!
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Something went wrong

  /auth/resetPassword:
    patch:
      tags:
        - auth
      summary: Reset the password
      description: >-
        Endpoint to set the password after checking otp
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: body
          in: body
          description: User credentials for authentication
          required: true
          schema:
            type: object
            properties:
              newPassword:
                type: string
              newPasswordConfirm:
                type: string
      responses:
        '200':
          description: Successful Sending a Password Change Email
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: true
              message: password changed successfully
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Something went wrong
        '401':
          description: Unauthorized - Should be authorized to complete the request
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Unauthorized user
  /profile/updateUsername:
    patch:
      tags:
        - profile
      summary: Update the username
      description: Endpoint for username change.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        # - name: Cookie
        #   in: header
        #   description: Cookie containing the access token. browser will set
        #   required: true
        #   type: string
        - name: body
          in: body
          description: User new password for authentication
          required: true
          schema:
            type: object
            properties:
              newUsername:
                type: string
      responses:
        '200':
          description: Successful Username-Change
          schema:
            type: object
            properties:
              status:
                type: boolean
              data:
                type: object
                properties:
                  user:
                    type: object
                    properties:
                      id:
                        type: bigint
                      email:
                        type: string
                      username:
                        type: string
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Something went wrong
        '401':
          description: Unauthorized - Should be authorized to complete the request
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Unauthorized user
  /profile/updateEmail:
    patch:
      tags:
        - profile
      summary: Update the user email
      description: Endpoint for user email change.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: body
          in: body
          required: true
          schema:
            type: object
            properties:
              newEmail:
                type: string
      responses:
        '200':
          description: Successful UserEmail-Change
          schema:
            type: object
            properties:
              status:
                type: boolean
              data:
                type: object
                properties:
                  user:
                    type: object
                    properties:
                      id:
                        type: bigint
                      email:
                        type: string
                      username:
                        type: string
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Something went wrong
        '401':
          description: Unauthorized - Should be authorized to complete the request
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Unauthorized user
  /users/{username}/isUsernameFound:
    get:
      tags:
        - auth
      summary: Is this username registered?
      description: Endpoint that Checks if a user with this username is registered before.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: username
          in: path
          required: true
          type: string
      responses:
        '200':
          description: Successful UserEmail-Change
          schema:
            type: object
            properties:
              status:
                type: boolean
              data:
                type: object
                properties:
                  isFound:
                    type: boolean
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Something went wrong
  /users/{email}/isEmailFound:
    get:
      tags:
        - auth
      summary: Is this email registered?
      description: Endpoint that Checks if a user with this email is registered before.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: email
          in: path
          required: true
          type: string
      responses:
        '200':
          description: Successful UserEmail-Change
          schema:
            type: object
            properties:
              status:
                type: boolean
              data:
                type: object
                properties:
                  isFound:
                    type: boolean
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Something went wrong
  /users/{username}/followers:
    get:
      tags:
        - user interactions
      summary: Fetch a list of followers for the username
      description: Endpoint to get the followers of the username.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: username
          in: path
          required: true
          type: string
      responses:
        '200':
          description: Successful Get
          schema:
            type: object
            properties:
              status:
                type: boolean
              data:
                type: object
                properties:
                  users:
                    type: array
                    items:
                      type: object
                      properties:
                        userId:
                          type: string
                        username:
                          type: string
                        name:
                          type: string
                        bio:
                          type: string
                        imageUrl:
                          type: string
                        isFollowed:
                          type: boolean
                        isFollowing:
                          type: boolean
                        followersCount:
                          type: integer
                        followingsCount:
                          type: integer
                  name:
                    type: string

        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Something went wrong
        '401':
          description: Unauthorized - Should be authorized to complete the request
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Unauthorized user
  /users/{username}/followings:
    get:
      tags:
        - user interactions
      summary: Fetch a list of users followed by the username
      description: Endpoint to get the users following the username.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: userId
          in: path
          required: true
          type: string
      responses:
        '200':
          description: Successful Get
          schema:
            type: object
            properties:
              status:
                type: boolean
              data:
                type: object
                properties:
                  users:
                    type: array
                    items:
                      type: object
                      properties:
                        userId:
                          type: string
                        username:
                          type: string
                        name:
                          type: string
                        bio:
                          type: string
                        imageUrl:
                          type: string
                        isFollowed:
                          type: boolean
                        isFollowing:
                          type: boolean
                        followersCount:
                          type: integer
                        followingsCount:
                          type: integer
                  name:
                    type: string
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Something went wrong
        '401':
          description: Unauthorized - Should be authorized to complete the request
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Unauthorized user
  /users/{username}/follow:
    post:
      tags:
        - user interactions
      summary: Follow the username
      description: >-
        Endpoint that take the username and make the authenticated username
        follow him.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: username
          in: path
          required: true
          type: string
      responses:
        '201':
          description: Successful Follow
          schema:
            type: object
            properties:
              status:
                type: boolean
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Something went wrong
        '401':
          description: Unauthorized - Should be authorized to complete the request
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Unauthorized user
  /users/{username}/unfollow:
    delete:
      tags:
        - user interactions
      summary: UnFollow the username
      description: >-
        Endpoint that take the username and make the authenticated username
        unfollow him - delete the relation.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: username
          in: path
          required: true
          type: string
      responses:
        '200':
          description: Successful UnFollow
          schema:
            type: object
            properties:
              status:
                type: boolean
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Something went wrong
        '401':
          description: Unauthorized - Should be authorized to complete the request
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Unauthorized user
  /users/{username}/mute:
    post:
      tags:
        - user interactions
      summary: Mute the username
      description: >-
        Endpoint that take the username and make the authenticated username mute
        him.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: username
          in: path
          required: true
          type: string
      responses:
        '201':
          description: Successful Mute
          schema:
            type: object
            properties:
              status:
                type: boolean
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Something went wrong
        '401':
          description: Unauthorized - Should be authorized to complete the request
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Unauthorized user
  /users/{username}/unmute:
    delete:
      tags:
        - user interactions
      summary: UnMute the username
      description: >-
        Endpoint that take the username and make the authenticated username mute
        him.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: username
          in: path
          required: true
          type: string
      responses:
        '200':
          description: Successful UnMute
          schema:
            type: object
            properties:
              status:
                type: boolean
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Something went wrong
        '401':
          description: Unauthorized - Should be authorized to complete the request
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Unauthorized user
  /users/mutedUsers:
    get:
      tags:
        - user interactions
      summary: Fetch a list of users muted by the user thath signed in
      description: Endpoint to get the users following the username.
      consumes:
        - application/json
      produces:
        - application/json
      responses:
        '200':
          description: Successful Get
          schema:
            type: object
            properties:
              status:
                type: boolean
              data:
                type: object
                properties:
                  users:
                    type: array
                    items:
                      type: object
                      properties:
                        userId:
                          type: string
                        username:
                          type: string
                        name:
                          type: string
                        bio:
                          type: string
                        imageUrl:
                          type: string
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Something went wrong
        '401':
          description: Unauthorized - Should be authorized to complete the request
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Unauthorized user
  /users/{username}/block:
    post:
      tags:
        - user interactions
      summary: Block the username
      description: >-
        Endpoint that take the username and make the authenticated username
        block him.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: username
          in: path
          required: true
          type: string
      responses:
        '201':
          description: Successful Block
          schema:
            type: object
            properties:
              status:
                type: boolean
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Something went wrong
        '401':
          description: Unauthorized - Should be authorized to complete the request
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Unauthorized user
  /users/{username}/unblock:
    delete:
      tags:
        - user interactions
      summary: UnBlock the username
      description: >-
        Endpoint that take the username and make the authenticated username
        unblock him.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: username
          in: path
          required: true
          type: string
      responses:
        '200':
          description: Successful Unblock
          schema:
            type: object
            properties:
              status:
                type: boolean
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Something went wrong
        '401':
          description: Unauthorized - Should be authorized to complete the request
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Unauthorized user
  /users/blockedUsers:
    get:
      tags:
        - user interactions
      summary: Fetch a list of users blocked by the username
      description: Endpoint to get the users blocked by the entered username.
      consumes:
        - application/json
      produces:
        - application/json
      responses:
        '200':
          description: Successful Get
          schema:
            type: object
            properties:
              status:
                type: boolean
              data:
                type: object
                properties:
                  users:
                    type: array
                    items:
                      type: object
                      properties:
                        userId:
                          type: string
                        username:
                          type: string
                        name:
                          type: string
                        bio:
                          type: string
                        imageUrl:
                          type: string
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Something went wrong
        '401':
          description: Unauthorized - Should be authorized to complete the request
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Unauthorized user
  /users/search/pageNum?query="string":
    get:
      tags:
        - search
      summary: >-
        Search for matching users using their username or screen name (or part
        of them).
      description: Endpoint to search for users by username or screen name and get 10 as max in array.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: query
          in: query
          description: The username or screen name to search for.
          required: true
          type: string
        - name: pageNum
          in: path
          description: The pageNum of the tweets of user.
          required: true
          type: string
      responses:
        '200':
          description: Successful Get
          schema:
            type: object
            properties:
              status:
                type: boolean
              data:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                    email:
                      type: string
                    screenName:
                      type: string
                    username:
                      type: string
                    profileImageURL:
                      type: string
                    bio:
                      type: string
                    followersCount:
                      type: string
                    followingCount:
                      type: string
                    isFollowed:
                      type: boolean
                    isFollowing:
                      type: boolean
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
  /profile/updateBanner:
    post:
      tags:
        - profile
      summary: Add a profile banner
      description: Endpoint to update or add a profile banner.
      consumes:
        - multipart/form-data
      produces:
        - application/json
      parameters:
        - name: file
          in: formData
          description: The banner photo to update.
          required: true
          type: file
      responses:
        '200':
          description: Successful Update
          schema:
            type: object
            properties:
              status:
                type: boolean
              data:
                type: object
                properties:
                  bannerUrl:
                    type: string
        '400':
          description: >-
            Either an image was not provided, or the image data could not be
            processed
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
        '422':
          description: The image could not be resized, or is too large.
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
  /profile/deleteBanner:
    delete:
      tags:
        - profile
      summary: Delete a banner picture.
      description: Endpoint to delete a banner picture.
      consumes:
        - application/json
      produces:
        - application/json
      responses:
        '200':
          description: Successful Update
          schema:
            type: object
            properties:
              status:
                type: boolean
              name:
                type: string
                description: The user's name.
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
  /profile/updatePicture:
    post:
      tags:
        - profile
      summary: Update a profile picture given the new picture.
      description: Endpoint to update a profile picture.
      consumes:
        - multipart/form-data
      produces:
        - application/json
      parameters:
        - name: photo
          in: formData
          description: The banner photo to update.
          required: true
          type: file
        - name: description
          in: formData
          description: The description on profile.
          required: false
          type: string
      responses:
        '200':
          description: Successful Update
          schema:
            type: object
            properties:
              status:
                type: boolean
              name:
                type: string
                description: The user's name.
              description:
                type: string
                description: The user's description.
              profileImageUrl:
                type: string
                description: The URL of the updated profile picture.
        '400':
          description: >-
            Either an image was not provided, or the image data could not be
            processed
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
        '422':
          description: The image could not be resized, or is too large.
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
  /profile/deletePicture:
    delete:
      tags:
        - profile
      summary: Delete a profile picture.
      description: Endpoint to delete a profile picture.
      consumes:
        - application/json
      produces:
        - application/json
      responses:
        '200':
          description: Successful Update
          schema:
            type: object
            properties:
              status:
                type: boolean
              name:
                type: string
                description: The user's name.
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
  /profile/update:
    patch:
      tags:
        - profile
      summary: Update the profile of a specific user.
      description: Endpoint to update the profile of a specific user.
      consumes:
        - multipart/form-data
      produces:
        - application/json
      parameters:
        - name: profilePhoto
          in: formData
          description: The profile photo to update.
          required: false
          type: file
        - name: bannerPhoto
          in: formData
          description: The banner photo to update.
          required: false
          type: file
        - name: name
          in: formData
          description: The user's name.
          required: false
          type: string
        - name: bio
          in: formData
          description: The user's bio.
          required: false
        - name: website
          in: formData
          description: The user's website.
          required: false
        - name: location
          in: formData
          description: The user's location.
          required: false
        - name: birthDate
          in: formData
          description: The user's birthDate.
          required: false
        - name: isUpdated
          in: formData
          description: if the user updated or deleted or not banner photo .
          required: true
      responses:
        '200':
          description: Successful Update
          schema:
            type: object
            properties:
              status:
                type: boolean
              data:
                type: object
                properties:
                  userId:
                    type: integer
                  username:
                    type: string
                    description: the user's username.
                  isConfirmed:
                    type: boolean
                  email:
                    type: string
                  name:
                    type: string
                    description: The user's name.
                  bio:
                    type: string
                    description: The user's bio.
                  website:
                    type: string
                    description: The user's website.
                  location:
                    type: string
                    description: The user's location.
                  imageUrl:
                    type: string
                    description: The user's profile.
                  bannerUrl:
                    type: string
                    description: The user's banner Picture.
                  followersCount:
                    type: integer
                    description: The user's followers count.
                  followingsCount:
                    type: integer
                    description: The user's followings count.
                  dateOfBirth:
                    type: date
                    description: the user's date of birth.
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
  /profile/{username}:
    get:
      tags:
        - profile
      summary: Get the profile of a specific user.
      description: Endpoint to get the profile of a specific user.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: username
          in: path
          description: The username of the user to get the profile of.
          required: true
          type: string
      responses:
        '200':
          description: Successful Get
          schema:
            type: object
            properties:
              status:
                type: boolean
              data:
                type: object
                properties:
                  userId:
                    type: string
                    description: The user's ID.
                  name:
                    type: string
                    description: The user's name.
                  username:
                    type: string
                    description: The user's name.
                  bio:
                    type: string
                    description: The user's bio.
                  website:
                    type: string
                    description: The user's website.
                  location:
                    type: string
                    description: The user's location.
                  imageUrl:
                    type: string
                    description: The URL of the user's profile picture.
                  bannerUrl:
                    type: string
                    description: The URL of the user's banner picture.
                  birthdate:
                    type: date
                  isConfirmed:
                    type: boolean
                  isFollowed:
                    type: boolean
                    description: Is the current user follow this user profile.
                  isFollowing:
                    type: boolean
                    description: Is this user profile follow the current user.
                  isMuted:
                    type: boolean
                    description: Is the current user mutes this user.
                  isBlocked:
                    type: boolean
                    description: is the current user blocks this user.
                  isBlockingMe:
                    type: boolean
                    description: is the current user blocked by this user.
                  followersCount:
                    type: integer
                  followingsCount:
                    type: integer
                  createdAt:
                    type: date
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
  ###################################################
  /profile/{conversationId}/messages:
    get:
      tags:
        - profile
      summary: Fetch the messages of a conversation
      description: >-
        Endpoint that return all the messages of a conversation.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: conversationId
          in: path
          description: The ID of the conversation between the two users.
          required: true
          type: string
      responses:
        '200':
          description: Successful Get Messages
          schema:
            type: object
            properties:
              status:
                type: boolean
              data:
                type: object
                properties:
                  messages:
                    type: array
                    items:
                      type: object
                      properties:
                        messagesId:
                          type: string
                        text:
                          type: string
                        isSeen:
                          type: boolean
                        isFromMe:
                          type: boolean
                        time:
                          type: string
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Something went wrong
        '401':
          description: Unauthorized - Should be authorized to complete the request
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Unauthorized user
  ####################################################
  /conversations:
    get:
      tags:
        - profile
      summary: List the conversations of the authenticated user
      description: >-
        Endpoint that get my conversations with all. returned array will be sorted by last message time
      consumes:
        - application/json
      produces:
        - application/json
      responses:
        '200':
          description: Successful Send
          schema:
            type: object
            properties:
              status:
                type: boolean
              data:
                type: object
                properties:
                  conversations:
                    type: array
                    items:
                      type: object
                      properties:
                        conversationId:
                          type: integer
                        isConversationSeen:
                          type: boolean
                        contact:
                          type: object
                          properties:
                            InConversation:
                              type: boolean
                            imageUrl:
                              type: string
                            id:
                              type: string
                              description: The user's ID.
                            email:
                              type: string
                            name:
                              type: string
                              description: The user's name.
                            username:
                              type: string
                              description: The user's name.
                            commonFollowersCnt:
                              type: integer
                            commonFollowers:
                              type: array
                              items:
                                type: object
                                properties:
                                  imageUrl:
                                    type: string
                                  username:
                                    type: string
                                  name:
                                    type: string
                        lastMessage:
                          type: object
                          properties:
                            id:
                              type: integer
                            isSeen:
                              type: boolean
                            timestamp:
                              type: string
                              example: '2023-11-20T14:14:37.588Z'
                            text:
                              type: string
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Something went wrong
        '401':
          description: Unauthorized - Should be authorized to complete the request
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Unauthorized user
  ####################################################
  /conversations/startConversation:
    post:
      tags:
        - profile
      summary: start a conversation
      description: >-
        Endpoint to sart a conversation
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: body
          in: body
          required: true
          schema:
            type: object
            properties:
              userIds:
                type: array
                items:
                  type: integer

      responses:
        '200':
          description: Successful Send
          schema:
            type: object
            properties:
              status:
                type: boolean
              data:
                type: object
                properties:
                  newConversations:
                    type: array
                    items:
                      type: object
                      properties:
                        conversationId:
                          type: string
                        user2Id:
                          type: integer
                        user1Id:
                          type: integer
                        isUsersActive:
                          type: object
                          properties:
                            userId_user1Id:
                              type: boolean
                            userId_user2Id:
                              type: boolean
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Something went wrong
        '401':
          description: Unauthorized - Should be authorized to complete the request
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Unauthorized user
              ####################################################
  /conversations/leaveConversation:
    delete:
      tags:
        - profile
      summary: leave a conversation
      description: >-
        Endpoint to leave a conversation
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: body
          in: body
          required: true
          schema:
            type: object
            properties:
              conversationId:
                type: string

      responses:
        '200':
          description: Successful Send
          schema:
            type: object
            properties:
              status:
                type: boolean
              messages:
                type: string
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Something went wrong
        '401':
          description: Unauthorized - Should be authorized to complete the request
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Unauthorized user
  ######################################################

  /conversations/unseenConversationsCnt:
    get:
      tags:
        - profile
      summary: Get number of unseen conversations
      description: >-
        Endpoint that get my conversations with all.
      consumes:
        - application/json
      produces:
        - application/json
      responses:
        '200':
          description: Successful Get
          schema:
            type: object
            properties:
              status:
                type: boolean
              data:
                type: object
                properties:
                  unseenCnt:
                    type: integer
                    example: 10

        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Something went wrong
        '401':
          description: Unauthorized - Should be authorized to complete the request
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Unauthorized user
  ###################################################
  /notifications:
    post:
      tags:
        - profile
      summary: Get my notifications
      description: >-
        Endpoint that return the notifications of the authenticated username.
      consumes:
        - application/json
      produces:
        - application/json
      responses:
        '200':
          description: Successful Mute
          schema:
            type: object
            properties:
              status:
                type: boolean
              data:
                type: object
                properties:
                  notifications:
                    type: array
                    items:
                      type: object
                      properties:
                        notificationId:
                          type: string
                        content:
                          type: string
                        isSeen:
                          type: boolean
                        timestamp:
                          type: date
                          example: '2023-11-20T14:14:37.588Z'
                        senderImgUrl:
                          type: string
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Something went wrong
        '401':
          description: Unauthorized - Should be authorized to complete the request
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Unauthorized user
  ###################################################
  /notifications/unseenNotificationsCnt:
    post:
      tags:
        - profile
      summary: Get the number of unseen notifications
      description: >-
        Endpoint that return the number of notifications of the authenticated user.
      consumes:
        - application/json
      produces:
        - application/json
      responses:
        '200':
          description: Successful Mute
          schema:
            type: object
            properties:
              status:
                type: boolean
              data:
                type: object
                properties:
                  unseenCnt:
                    type: integer
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Something went wrong
        '401':
          description: Unauthorized - Should be authorized to complete the request
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
          examples:
            application/json:
              status: false
              message: Unauthorized user
  /tweets/add:
    post:
      tags:
        - tweets
      summary: Add a new tweet.
      description: Endpoint to add a new tweet. one of the two parameters is required.
      consumes:
        - multipart/form-data
      produces:
        - application/json
      parameters:
        - name: tweetText
          type: string
          in: formData
          description: The text of the tweet.
          required: false

        - name: media
          in: formData
          description: The new tweet attachments of max 4.
          required: false
          type: file
          maxItems: 4

        - name: trends
          in: formData
          description: list of trends (hashtags) from the added tweet
          required: false
      responses:
        '200':
          description: Successful Add
          schema:
            type: object
            properties:
              status:
                type: boolean
              data:
                type: object
                properties:
                  id:
                    type: string
                    description: The ID of the new tweet.
                  text:
                    type: string
                    description: The text of the new tweet.
                  createdAt:
                    type: string
                    description: The date and time the tweet was created.
                  user:
                    type: object
                    properties:
                      userId:
                        type: integer
                      profileImageURL:
                        type: string
                        description: The profile of the user that create the tweet.
                      screenName:
                        type: string
                        description: The screen name of the user that create the tweet.
                      username:
                        type: string
                        description: The username that create the tweet.
                      bio:
                        type: string
                      followersCount:
                        type: string
                      followingCount:
                        type: string
                      isFollowed:
                        type: boolean
                      isFollowing:
                        type: boolean
                  attachmentsURL:
                    type: array
                    items:
                      type: string
                  isRetweet:
                    type: boolean
                  isLiked:
                    type: boolean
                  isRetweeted:
                    type: boolean
                  isReplied:
                    type: boolean
                  likesCount:
                    type: integer
                  retweetsCount:
                    type: integer
                  repliesCount:
                    type: integer
                  retweetedUser:
                    type: object

        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string

  /tweets/{tweetId}/deleteTweet:
    delete:
      tags:
        - tweets
      summary: Delete a tweet by given a tweetid.
      description: Endpoint to delete a tweet.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: tweetId
          in: path
          description: The ID of the tweet to delete.
          required: true
          type: string
      responses:
        '200':
          description: Successful Delete
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string

  /tweets/{tweetId}: ## naming
    get:
      tags:
        - tweets
      summary: Get tweet info by tweetId  .
      description: Endpoint to get tweet by tweetId.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: tweetId
          in: path
          description: The ID of the tweet to get the tweet for.
          required: true
          type: string
      responses:
        '200':
          description: Successful Get
          schema:
            type: object
            properties:
              status:
                type: boolean
              data:
                type: object
                properties:
                  id:
                    type: string
                    description: The ID of the new tweet.
                  text:
                    type: string
                    description: The text of the new tweet.
                  createdAt:
                    type: string
                    description: The date and time the tweet was created.
                  user:
                    type: object
                    properties:
                      userId:
                        type: integer
                      profileImageURL:
                        type: string
                        description: The profile of the user that create the tweet.
                      screenName:
                        type: string
                        description: The screen name of the user that create the tweet.
                      username:
                        type: string
                        description: The username that create the tweet.
                      bio:
                        type: string
                      followersCount:
                        type: string
                      followingCount:
                        type: string
                      isFollowed:
                        type: boolean
                      isFollowing:
                        type: boolean
                  attachmentsURL:
                    type: array
                    items:
                      type: string
                  isRetweet:
                    type: boolean
                  isLiked:
                    type: boolean
                  isRetweeted:
                    type: boolean
                  isReplied:
                    type: boolean
                  likesCount:
                    type: integer
                  retweetsCount:
                    type: integer
                  repliesCount:
                    type: integer
                  retweetedUser:
                    type: object
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
  /tweets/{tweetId}/replies:
    get:
      tags:
        - tweets
      summary: Get the replies of a certain tweet.
      description: Endpoint to get the replies of a certain tweet.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: tweetId
          in: path
          description: The ID of the tweet to get the replies of.
          required: true
          type: string
      responses:
        '200':
          description: Successful Get
          schema:
            type: object
            properties:
              status:
                type: boolean
              data:
                type: array
                items:
                  type: object
                  properties:
                    replyId:
                      type: integer
                      description: The ID of the reply.
                    replyTweetId:
                      type: integer
                      description: The ID of the tweet.
                    replyUserId:
                      type: integer
                      description: The ID of the user.
                    replyText:
                      type: string
                      description: The text of the reply.
                    createdAt:
                      type: '2023-11-27 02:17:25'
                      description: The date and time the reply was created.
                    username:
                      type: string
                      description: The name of the user that make reply.
                    screenName:
                      type: string
                    bio:
                      type: string
                      description: The bio of the user that make reply.
                    profileImageURL:
                      type: string
                      description: The image of the user that make reply.
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
  /tweets/{tweetId}/addReply: # body object
    post:
      tags:
        - tweets
      summary: Add a reply to a tweet using the userId in cookie.
      description: Endpoint to add a reply to a tweet.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: tweetId
          in: path
          description: The ID of the tweet to reply to.
          required: true
          type: string
        - name: body
          in: body
          description: Reply text.
          required: false
          schema:
            type: object
            properties:
              text:
                type: string
                description: The text of the Reply.
      responses:
        '200':
          description: Successful reply addition.
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
              data:
                type: array
                items:
                  type: object
                  properties:
                    replyId:
                      type: integer
                    replyTweetId:
                      type: integer
                    replyUserId:
                      type: integer
                    replyText:
                      type: string
                    createdAt:
                      type: '2023-11-27 02:17:25'
                    username:
                      type: string
                      description: The name of the user that make reply.
                    screenName:
                      type: string
                    bio:
                      type: string
                      description: The bio of the user that make reply.
                    profileImageURL:
                      type: string
                      description: The image of the user that make reply.
                    followersCount:
                      type: integer
                    followingCount:
                      type: integer
                    isFollowed:
                      type: boolean
        '400':
          description: Bad request - something went wrong.
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
  /tweets/{tweetId}/deleteReplies/{replyId}:
    delete:
      tags:
        - tweets
      summary: Delete a reply from a tweet.
      description: Endpoint to delete a reply from a tweet.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: tweetId
          in: path
          description: The ID of the tweet which contain the reply.
          required: true
          type: string
        - name: replyId
          in: path
          description: The ID of the reply to delete.
          required: true
          type: string
      responses:
        '200':
          description: Successful reply deletion.
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
        '400':
          description: Bad request - something went wrong.
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string

  /tweets/{tweetId}/retweet:
    post:
      tags:
        - tweets
      summary: Add a retweet.
      description: Endpoint to add a retweet which takes a tweetId and userId .
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: tweetId
          in: path
          type: string
          description: The userId that add retweet.
          required: true
        - name: body
          in: body
          description: The retweet to add.
          required: true
          schema:
            type: object
            properties:
              retweetId:
                type: string
                description: The ID of the tweet to retweet.
      responses:
        '200':
          description: Successful Add
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
  /users/{userId}/retweets:
    get:
      tags:
        - tweets
      summary: Get a list of retweets for a user (Canceled).
      description: Endpoint to get a list of retweets for a user.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: userId
          in: path
          description: The ID of the user to get the retweets for.
          required: true
          type: string
      responses:
        '200':
          description: Successful request.
          schema:
            type: object
            properties:
              status:
                type: boolean
              data:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      description: The ID of the tweet.
                    text:
                      type: string
                      description: The text of the tweet.
                    createdAt:
                      type: string
                      description: The date and time the tweet was created.
                    attachmentsURL:
                      type: array
                      items:
                        type: string
                    retweetedUser:
                      type: object
                      properties:
                        userId:
                          type: string
                          description: The ID of the user who retweeted.
                        username:
                          type: string
                          description: The name of the user who retweeted.
                        screenName:
                          type: string
                          description: The screen name of the user who retweeted.
                        profileImageURL:
                          type: string
                          description: The profile picture of the user who retweeted.
                    user:
                      type: object
                      properties:
                        userId:
                          type: string
                          description: The ID of the user who retweeted.
                        username:
                          type: string
                          description: The username of the user that create the tweet.
                        screenName:
                          type: string
                          description: The screen name of the user that make the tweet.
                        profileImageURL:
                          type: string
                          description: The profile picture of the user that create the tweet .
                    isLiked:
                      type: boolean
                      description: Is the current user liked this tweet.
                    isRetweeted:
                      type: boolean
                      description: Is the current user retweeted this tweet.
                    likesCount:
                      type: integer
                      description: Total number of likes on tweet.
                    retweetsCount:
                      type: integer
                      description: Total number of likes on tweet.
                    repliesCount:
                      type: integer
                      description: Total number of replies on tweet.

        '400':
          description: Bad request - something went wrong.
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string

  /tweets/{tweetId}/deleteRetweet:
    delete:
      tags:
        - tweets
      summary: Delete a retweet.
      description: Endpoint to delete a retweet.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: tweetId
          in: path
          description: The ID of the retweet to delete.
          required: true
          type: string
      responses:
        '200':
          description: Successful Delete
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string

  /tweets/{tweetId}/addLike:
    post:
      tags:
        - tweets
      summary: Like a tweet.
      description: Endpoint to like a tweet.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: tweetId
          in: path
          description: The ID of the tweet to like.
          required: true
          type: string
      responses:
        '200':
          description: Successfully liked tweet.
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
        '400':
          description: Bad request - something went wrong.
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
  /tweets/{tweetId}/deleteLike:
    delete:
      tags:
        - tweets
      summary: Remove a like from a tweet.
      description: Endpoint to remove a like from a tweet.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: tweetId
          in: path
          description: The ID of the tweet to remove the like from.
          required: true
          type: string
      responses:
        '200':
          description: Successfully removed like.
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
        '400':
          description: Bad request - something went wrong.
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
  /tweets/{tweetId}/retweeters:
    get:
      tags:
        - tweets
      summary: Get a list of retweeters of a certain tweet.
      description: Endpoint to get a list of retweeters of a certain tweet.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: tweetId
          in: path
          description: The ID of the tweet to get the retweeters of.
          required: true
          type: string
      responses:
        '200':
          description: Successful Get
          schema:
            type: object
            properties:
              status:
                type: boolean
              data:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      description: The ID of the retweeter.
                    name:
                      type: string
                      description: The name of the retweeter.
                    screenName:
                      type: string
                      description: The screen name of the retweeter.
                    profileImageURL:
                      type: string
                      description: The profile of the user that retweet.
                    bio:
                      type: string
                    isFollowed:
                      type: boolean
                      description: Is the user follow this user or not.
                    isFollowing:
                      type: boolean
                    followersCount:
                      type: integer
                    followingCount:
                      type: integer
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
        '404':
          description: Nolist was found
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
  /tweets/{tweetId}/likers:
    get:
      tags:
        - tweets
      summary: Get a list of likers for a tweet.
      description: Endpoint to get a list of likers for a tweet.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: tweetId
          in: path
          description: The ID of the tweet to get the likers for.
          required: true
          type: string
      responses:
        '200':
          description: Successful request.
          schema:
            type: object
            properties:
              status:
                type: boolean
              data:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      description: The ID of the retweeter.
                    name:
                      type: string
                      description: The name of the retweeter.
                    screenName:
                      type: string
                      description: The screen name of the retweeter.
                    profileImageURL:
                      type: string
                      description: The profile of the user that retweet.
                    bio:
                      type: string
                    isFollowed:
                      type: boolean
                      description: Is the user follow this user or not.
                    isFollowing:
                      type: boolean
                    followersCount:
                      type: integer
                    followingCount:
                      type: integer
        '400':
          description: Bad request - something went wrong.
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
  /tweets/search/pageNum?query="string":
    get:
      tags:
        - search
      summary: Get a list of tweets that matches (either fully or partially) the sent string.
      description: Endpoint to get a list of tweets that matches (either fully or partially) the sent string and get a max 10 objects in array.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: searchString
          in: query
          description: The string to search for.
          required: true
          type: string
        - name: pageNum
          in: path
          description: The pageNum of the tweets of user.
          required: true
          type: string
      responses:
        '200':
          description: Successful request.
          schema:
            type: object
            properties:
              status:
                type: boolean
              data:
                type: object
                properties:
                  id:
                    type: string
                    description: The ID of the new tweet.
                  text:
                    type: string
                    description: The text of the new tweet.
                  createdAt:
                    type: string
                    description: The date and time the tweet was created.
                  user:
                    type: object
                    properties:
                      userId:
                        type: integer
                      profileImageURL:
                        type: string
                        description: The profile of the user that create the tweet.
                      screenName:
                        type: string
                        description: The screen name of the user that create the tweet.
                      username:
                        type: string
                        description: The username that create the tweet.
                      bio:
                        type: string
                      followersCount:
                        type: string
                      followingCount:
                        type: string
                      isFollowed:
                        type: boolean
                      isFollowing:
                        type: boolean
                  attachmentsURL:
                    type: array
                    items:
                      type: string
                  isRetweet:
                    type: boolean
                  isLiked:
                    type: boolean
                  isRetweeted:
                    type: boolean
                  isReplied:
                    type: boolean
                  likesCount:
                    type: integer
                  retweetsCount:
                    type: integer
                  repliesCount:
                    type: integer
                  retweetedUser:
                    type: object
        '400':
          description: Bad request - something went wrong.
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
  /tweets/{tweetId}/addMedia:
    post:
      tags:
        - tweets
      summary: Add media to a tweet.
      description: Endpoint to add media to a tweet.
      consumes:
        - multipart/form-data
      produces:
        - application/json
      parameters:
        - name: tweetId
          in: path
          description: The ID of the tweet to add media to.
          required: true
          type: string
        - name: media
          in: formData
          description: The media to add to the tweet.
          required: true
          type: file
      responses:
        '200':
          description: Successful media addition.
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
        '400':
          description: Bad request - something went wrong.
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
  /tweets/{tweetId}/media:
    get:
      tags:
        - tweets
      summary: Get media from a tweet.
      description: Endpoint to get media from a tweet.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: tweetId
          in: path
          description: The ID of the tweet to get media from.
          required: true
          type: string
      responses:
        '200':
          description: Successful media retrieval.
          schema:
            type: object
            properties:
              status:
                type: boolean
              data:
                type: array
                items:
                  type: object
                  properties:
                    mediaURL:
                      type: string
                      description: The media url.
        '400':
          description: Bad request - something went wrong.
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
  #######Timeline#######
  /users/{pageNum}/timeline:
    get:
      tags:
        - timeline
      summary: Get a list of tweets in the home page of the user of max .
      description: Endpoint to get a list of tweets in the home page of the user differ from the below api in logic in backend and get a max 10 objects in array.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: pageNum
          in: path
          description: The pageNum to get in the timeline.
          required: true
          type: string
      responses:
        '200':
          description: Successful request.
          schema:
            type: object
            properties:
              status:
                type: boolean
              data:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      description: The ID of the tweet.
                    text:
                      type: string
                      description: The text of the tweet.
                    createdAt:
                      type: string
                      description: The date and time the tweet was created.
                    attachmentsURL:
                      type: array
                      items:
                        type: string
                    retweetedUser:
                      type: object
                      properties:
                        userId:
                          type: string
                          description: The ID of the user who retweeted.
                        userName:
                          type: string
                          description: The name of the user who retweeted.
                        screenName:
                          type: string
                          description: The screen name of the user who retweeted.
                        profileImageURL:
                          type: string
                          description: The profile picture of the user who retweeted.
                        bio:
                          type: string
                          description: The bio of the user who retweeted.
                        followersCount:
                          type: integer
                          description: The count of followers of retweeter.
                        followingCount:
                          type: integer
                          description: The count of users that retweeter follow.
                        isFollowed:
                          type: boolean
                          description: Is the current user follow the retweeter.
                        isFollowing:
                          type: boolean
                          description: Is the current user followed by the retweeter.
                    user:
                      type: object
                      properties:
                        userid:
                          type: string
                          description: The ID of the user who posted the tweet.
                        userName:
                          type: string
                          description: The name of the user who posted the tweet.
                        screenName:
                          type: string
                          description: The screen name of the user who posted the tweet.
                        profileImageURL:
                          type: string
                          description: The profile picture of the user that create the tweet.
                        bio:
                          type: string
                          description: The bio of the user who creates the tweet.
                        followersCount:
                          type: integer
                          description: The count of followers of the user who creates the tweet.
                        followingCount:
                          type: integer
                          description: The count of users that the user who creates the tweet. follow.
                        isFollowed:
                          type: boolean
                          description: Is the current user follow the user who creates the tweet.
                        isFollowing:
                          type: boolean
                          description: Is the current user followed by the user who creates the tweet.
                    isLiked:
                      type: boolean
                      description: Is the current user liked this tweet.
                    isRetweeted:
                      type: boolean
                      description: Is the current user retweeted this tweet.
                    isReplied:
                      type: boolean
                      description: Is the current user replied to this tweet.
                    likesCount:
                      type: integer
                      description: Total number of likes on tweet.
                    retweetsCount:
                      type: integer
                      description: Total number of likes on tweet.
                    repliesCount:
                      type: integer
                      description: Total number of replies on tweet.
              total:
                type: integer
        '400':
          description: Bad request - something went wrong.
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
  /users/{username}/tweets/{pageNum}:
    get:
      tags:
        - timeline
      summary: Get user tweets  .
      description: Endpoint to get user tweets by user_id for a specific user and get max of 10 objects in data.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: username
          in: path
          description: The username of the user to get the tweets for.
          required: true
          type: string
        - name: pageNum
          in: path
          description: The pageNum of the tweets of user.
          required: true
          type: string
      responses:
        '200':
          description: Successful Get
          schema:
            type: object
            properties:
              status:
                type: boolean
              data:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      description: The ID of the tweet.
                    text:
                      type: string
                      description: The text of the tweet.
                    createdAt:
                      type: string
                      description: The date and time the tweet was created.
                    attachmentsURL:
                      type: array
                      items:
                        type: string
                    retweetedUser:
                      type: object
                      properties:
                        userId:
                          type: string
                          description: The ID of the user who retweeted.
                        userName:
                          type: string
                          description: The name of the user who retweeted.
                        screenName:
                          type: string
                          description: The screen name of the user who retweeted.
                        profileImageURL:
                          type: string
                          description: The profile picture of the user who retweeted.
                        bio:
                          type: string
                          description: The bio of the user who retweeted.
                        followersCount:
                          type: integer
                          description: The count of followers of retweeter.
                        followingCount:
                          type: integer
                          description: The count of users that retweeter follow.
                        isFollowed:
                          type: boolean
                          description: Is the current user follow the retweeter.
                        isFollowing:
                          type: boolean
                          description: Is the current user followed by the retweeter.
                    user:
                      type: object
                      properties:
                        userid:
                          type: string
                          description: The ID of the user who posted the tweet.
                        userName:
                          type: string
                          description: The name of the user who posted the tweet.
                        screenName:
                          type: string
                          description: The screen name of the user who posted the tweet.
                        profileImageURL:
                          type: string
                          description: The profile picture of the user that create the tweet.
                        bio:
                          type: string
                          description: The bio of the user who creates the tweet.
                        followersCount:
                          type: integer
                          description: The count of followers of the user who creates the tweet.
                        followingCount:
                          type: integer
                          description: The count of users that the user who creates the tweet. follow.
                        isFollowed:
                          type: boolean
                          description: Is the current user follow the user who creates the tweet.
                        isFollowing:
                          type: boolean
                          description: Is the current user followed by the user who creates the tweet.
                    isLiked:
                      type: boolean
                      description: Is the current user liked this tweet.
                    isRetweeted:
                      type: boolean
                      description: Is the current user retweeted this tweet.
                    isReplied:
                      type: boolean
                      description: Is the current user replied to this tweet.
                    likesCount:
                      type: integer
                      description: Total number of likes on tweet.
                    retweetsCount:
                      type: integer
                      description: Total number of likes on tweet.
                    repliesCount:
                      type: integer
                      description: Total number of replies on tweet.
              total:
                type: integer
        '400':
          description: Bad request - something went wrong
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
  /users/{username}/mentions/{pageNum}:
    get:
      tags:
        - timeline
      summary: Get tweets that the user mentioned in it.
      description: Endpoint to get tweets that the user mentioned in it and of max 10 tweets.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: username
          in: path
          description: The username of the user to get the mentions for.
          required: true
          type: string
        - name: pageNum
          in: path
          description: The pageNum of the mentions of user.
          required: true
          type: string
      responses:
        '200':
          description: Successful request.
          schema:
            type: object
            properties:
              status:
                type: boolean
              data:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      description: The ID of the tweet.
                    text:
                      type: string
                      description: The text of the tweet.
                    createdAt:
                      type: string
                      description: The date and time the tweet was created.
                    attachmentsURL:
                      type: array
                      items:
                        type: string
                    retweetedUser:
                      type: object
                      properties:
                        userId:
                          type: string
                          description: The ID of the user who retweeted.
                        userName:
                          type: string
                          description: The name of the user who retweeted.
                        screenName:
                          type: string
                          description: The screen name of the user who retweeted.
                        profileImageURL:
                          type: string
                          description: The profile picture of the user who retweeted.
                        bio:
                          type: string
                          description: The bio of the user who retweeted.
                        followersCount:
                          type: integer
                          description: The count of followers of retweeter.
                        followingCount:
                          type: integer
                          description: The count of users that retweeter follow.
                        isFollowed:
                          type: boolean
                          description: Is the current user follow the retweeter.
                        isFollowing:
                          type: boolean
                          description: Is the current user followed by the retweeter.
                    user:
                      type: object
                      properties:
                        userId:
                          type: string
                          description: The ID of the user who posted the tweet.
                        userName:
                          type: string
                          description: The name of the user who posted the tweet.
                        screenName:
                          type: string
                          description: The screen name of the user who posted the tweet.
                        profileImageURL:
                          type: string
                          description: The profile picture of the user that create the tweet.
                        bio:
                          type: string
                          description: The bio of the user who creates the tweet.
                        followersCount:
                          type: integer
                          description: The count of followers of the user who creates the tweet.
                        followingCount:
                          type: integer
                          description: The count of users that the user who creates the tweet. follow.
                        isFollowed:
                          type: boolean
                          description: Is the current user follow the user who creates the tweet.
                        isFollowing:
                          type: boolean
                          description: Is the current user followed by the user who creates the tweet.
                    isLiked:
                      type: boolean
                      description: Is the current user liked this tweet.
                    isRetweeted:
                      type: boolean
                      description: Is the current user retweeted this tweet.
                    isReplied:
                      type: boolean
                      description: Is the current user replied to this tweet.
                    likesCount:
                      type: integer
                      description: Total number of likes on tweet.
                    retweetsCount:
                      type: integer
                      description: Total number of likes on tweet.
                    repliesCount:
                      type: integer
                      description: Total number of replies on tweet.
              total:
                type: integer
        '400':
          description: Bad request - something went wrong.
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
  /users/{username}/likedTweets/{pageNum}:
    get:
      tags:
        - timeline
      summary: Get tweets liked by the user.
      description: Endpoint to get tweets liked by the user and get a max 10 tweets.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: username
          in: path
          description: The username of the user to get the liked tweets for.
          required: true
          type: string
        - name: pageNum
          in: path
          description: The pageNum of the likes of user.
          required: true
          type: string
      responses:
        '200':
          description: Successful request.
          schema:
            type: object
            properties:
              status:
                type: boolean
              data:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      description: The ID of the tweet.
                    text:
                      type: string
                      description: The text of the tweet.
                    createdAt:
                      type: string
                      description: The date and time the tweet was created.
                    attachmentsURL:
                      type: array
                      items:
                        type: string
                    retweetedUser:
                      type: object
                      properties:
                        userId:
                          type: string
                          description: The ID of the user who retweeted.
                        userName:
                          type: string
                          description: The name of the user who retweeted.
                        screenName:
                          type: string
                          description: The screen name of the user who retweeted.
                        profileImageURL:
                          type: string
                          description: The profile picture of the user who retweeted.
                        bio:
                          type: string
                          description: The bio of the user who retweeted.
                        followersCount:
                          type: integer
                          description: The count of followers of retweeter.
                        followingCount:
                          type: integer
                          description: The count of users that retweeter follow.
                        isFollowed:
                          type: boolean
                          description: Is the current user follow the retweeter.
                        isFollowing:
                          type: boolean
                          description: Is the current user followed by the retweeter.
                    user:
                      type: object
                      properties:
                        userId:
                          type: string
                          description: The ID of the user who posted the tweet.
                        userName:
                          type: string
                          description: The name of the user who posted the tweet.
                        screenName:
                          type: string
                          description: The screen name of the user who posted the tweet.
                        profileImageURL:
                          type: string
                          description: The profile picture of the user that create the tweet.
                        bio:
                          type: string
                          description: The bio of the user who creates the tweet.
                        followersCount:
                          type: integer
                          description: The count of followers of the user who creates the tweet.
                        followingCount:
                          type: integer
                          description: The count of users that the user who creates the tweet. follow.
                        isFollowed:
                          type: boolean
                          description: Is the current user follow the user who creates the tweet.
                        isFollowing:
                          type: boolean
                          description: Is the current user followed by the user who creates the tweet.
                    isLiked:
                      type: boolean
                      description: Is the current user liked this tweet.
                    isRetweeted:
                      type: boolean
                      description: Is the current user retweeted this tweet.
                    isReplied:
                      type: boolean
                      description: Is the current user replied to this tweet.
                    likesCount:
                      type: integer
                      description: Total number of likes on tweet.
                    retweetsCount:
                      type: integer
                      description: Total number of likes on tweet.
                    repliesCount:
                      type: integer
                      description: Total number of replies on tweet.
              total:
                type: integer
        '400':
          description: Bad request - something went wrong.
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
  /trends:
    get:
      tags:
        - trends
      summary: Get a list of available trends.
      description: Endpoint to get a list of available trends.
      consumes:
        - application/json
      produces:
        - application/json
      responses:
        '200':
          description: Successful request.
          schema:
            type: object
            properties:
              status:
                type: boolean
              data:
                type: array
                items:
                  type: object
                  properties:
                    name:
                      type: string
                      description: The name of the trend.
        '400':
          description: Bad request - something went wrong.
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string
  /trends/{trendName}/tweets/{pageNum}:
    get:
      tags:
        - trends
      summary: Get a list of tweets in a given trend.
      description: Endpoint to get a list of tweets in a given trend  and get a max 10 objects in array.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: trendName
          in: path
          description: The name of the trend to get tweets for.
          required: true
          type: string

        - name: pageNum
          in: path
          description: page number for tweet pagination
          required: true
          type: string
      responses:
        '200':
          description: Successful request.
          schema:
            type: object
            properties:
              status:
                type: boolean
              data:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      description: The ID of the tweet.
                    text:
                      type: string
                      description: The text of the tweet.
                    createdAt:
                      type: string
                      description: The date and time the tweet was created.
                    attachmentsURL:
                      type: array
                      items:
                        type: string
                    user:
                      type: object
                      properties:
                        userId:
                          type: string
                          description: The ID of the user who posted the tweet.
                        userName:
                          type: string
                          description: The name of the user who posted the tweet.
                        screenName:
                          type: string
                          description: The screen name of the user who posted the tweet.
                        profileImageURL:
                          type: string
                          description: The profile picture of the user that create the tweet .
                    isLiked:
                      type: boolean
                      description: Is the current user liked this tweet.
                    isRetweeted:
                      type: boolean
                      description: Is the current user retweeted this tweet.
                    likesCount:
                      type: integer
                      description: Total number of likes on tweet.
                    retweetsCount:
                      type: integer
                      description: Total number of likes on tweet.
                    repliesCount:
                      type: integer
                      description: Total number of replies on tweet.
        '400':
          description: Bad request - something went wrong.
          schema:
            type: object
            properties:
              status:
                type: boolean
              message:
                type: string