swagger.yaml

# docker run -p 89:8080 -e SWAGGER_JSON=/swagApp/swagger.json -v /home/zain/word-count-bee:/swagApp swaggerapi/swagger-ui
openapi: 3.0.3

info:
  version: "1.0.0"
  title: "File Processor API"
  description: "Word-Count is used to count the number of words, punctuations, lines and vowels in a text file. User can specify the file path and number of goroutines used for the calculations. Built in beego MVC framework, postgres and gorm."

servers:
  - url: "http://localhost:8080/api/v1"


paths:

  /signup:
    post:
      summary: "Create a new user"
      tags:
        - User
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                username:
                  type: string
                password:
                  type: string
      
      responses:
        "200":
          description: Successful operation
          content:
            application/json:
              schema:
                type: "object"
                properties:
                  message:
                    type: "string"
                    example: "User created successfully"
        "400":
          description: Username or password field empty
          content:
            application/json:
              schema:
                type: "object"
                properties:
                  message:
                    type: "string"
                    example: "Username and password are required"

        "409":
          description: Conflict - User already exists
          content:
            application/json:
              schema:
                type: "object"
                properties:
                  message:
                    type: "string"
                    example: "User already exists"
        
  
  /login:
    post:
      summary: "Login a user"
      tags:
        - User
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                username:
                  type: string
                password:
                  type: string
      
      responses:
        "200":
          description: Successful operation
          content:
            application/json:
              schema:
                type: "object"
                properties:
                  message:
                    type: "string"
                    example: "User logged in successfully!"
                  token:
                    type: "string"
                    example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3MDA5ODUwNTYsInJvbGUiOjAsInRpbWUiOjE3MDA5ODE0NTYsInVzZXIiOjB9.tfXrz-FBTO-NvA5XrxLF095cXDr0RdSh8aVHQA9j5gw"
                
        "400":
          description: Username or password field empty
          content:
            application/json:
              schema:
                type: "object"
                properties:
                  message:
                    type: "string"
                    example: "Username and password are required"
                
        "401":
          description: Username or password incorrect
          content:
            application/json:
              schema:
                type: "object"
                properties:
                  message:
                    type: "string"
                    example: "Invalid credentials. Please check your username and password."

  
  /upload:
    post:

      security:
        - jwt_auth: []

      summary: "Upload a file to process"
      tags:
        - Process
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
                routines:
                  type: integer
      
      responses:
        "200":
          description: Successful operation
          content:
            application/json:
              schema:
                type: "object"
                properties:
                  routines:
                    type: integer
                    example: 2
                  timeTaken:
                    type: string
                    example: "231.956µs"
                  totalCounts:
                    type: object
                    properties:
                      LineCount:
                        type: integer
                        example: 101
                      WordsCount:
                        type: integer
                        example: 280
                      VowelsCount:
                        type: integer
                        example: 1065
                      PunctuationCount:
                        type: integer
                        example: 637
  
        "400":
          description: No file uploaded
          content:
            application/json:
              schema:
                type: "object"
                properties:
                  message:
                    type: "string"
                    example: "No file uploaded"
        "401":
          description: Invalid token
          content:
            application/json:
              schema:
                type: "object"
                properties:
                  message:
                    type: "string"
                    example: "Invalid or expired token."
                
        "422":
          description: Invalid routines field
          content:
            application/json:
              schema:
                type: "object"
                properties:
                  message:
                    type: "string"
                    example: "Routines field is invalid"

  /statistics:
    post:
      security:
        - jwt_auth: []
      summary: "Find statistics for a file"
      tags:
        - Process
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                filename:
                  type: string
      
      responses:
        "200":
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Statistics'               
               
                

        "401":
          description: Invalid token
          content:
            application/json:
              schema:
                type: "object"
                properties:
                  message:
                    type: "string"
                    example: "Invalid or expired token."

        "404":
          description: No result found
          content:
            application/json:
              schema:
                type: "object"
                properties:
                  message:
                    type: "string"
                    example: "no processes found for the specified file and user"

  /processes:
    post:
      security:
        - jwt_auth: []

      summary: "Find processes for a user"
      tags:
        - Process
      
      responses:
        "200":
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Processes'                                           
                

        "401":
          description: Invalid token
          content:
            application/json:
              schema:
                type: "object"
                properties:
                  message:
                    type: "string"
                    example: "Invalid or expired token."

        "404":
          description: No result found
          content:
            application/json:
              schema:
                type: "object"
                properties:
                  message:
                    type: "string"
                    example: "no processes found for the specified user"


  /admin/login:
    post:
      # security:
      #   - jwt_auth: []
      
      summary: "Login an admin user"
      tags:
        - Admin
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                username:
                  type: string
                password:
                  type: string
      
      responses:
        "200":
          description: Successful operation
          content:
            application/json:
              schema:
                type: "object"
                properties:
                  message:
                    type: "string"
                    example: "User logged in successfully!"
                  token:
                    type: "string"
                    example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3MDA5ODUwNTYsInJvbGUiOjAsInRpbWUiOjE3MDA5ODE0NTYsInVzZXIiOjB9.tfXrz-FBTO-NvA5XrxLF095cXDr0RdSh8aVHQA9j5gw"
                
        "400":
          description: Username or password field empty
          content:
            application/json:
              schema:
                type: "object"
                properties:
                  message:
                    type: "string"
                    example: "Username and password are required"
                
        "401":
          description: Username or password incorrect
          content:
            application/json:
              schema:
                type: "object"
                properties:
                  message:
                    type: "string"
                    example: "Invalid credentials. Please check your username and password."


  /admin/processes:
    post:
      security:
        - admin_auth: []

      summary: "Find processes for all users"
      tags:
        - Admin
      
      responses:
        "200":
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Processes'               
                                              
                

        "401":
          description: Invalid token
          content:
            application/json:
              schema:
                type: "object"
                properties:
                  message:
                    type: "string"
                    example: "Invalid or expired token."

        "404":
          description: No result found
          content:
            application/json:
              schema:
                type: "object"
                properties:
                  message:
                    type: "string"
                    example: "no processes found"


  /admin/statistics:
    post:
      security:
        - admin_auth: []

      summary: "Find statistics for a file"
      tags:
        - Admin
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                filename:
                  type: string
      
      responses:
        "200":
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Statistics'               
                

        "401":
          description: Invalid token
          content:
            application/json:
              schema:
                type: "object"
                properties:
                  message:
                    type: "string"
                    example: "Invalid or expired token."

        "404":
          description: No result found
          content:
            application/json:
              schema:
                type: "object"
                properties:
                  message:
                    type: "string"
                    example: "no processes found for the specified file"


  /migrate:
    get:
      security:
        - db_key: []
      summary: "Migrate the database"
      tags:
        - Database
      responses:
        200:
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Migration'
        
        422:
          description: Invalid key
          content:
            application/json:
              schema:
                type: "object"
                properties:
                  message:
                    type: "string"
                    example: "Invalid key"
  
  /role:
    post:
      security:
        - db_key: []
      summary: "Make a user admin"
      tags:
        - Database
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                username:
                  type: string
      responses:
        200:
          description: Successful operation
          content:
            application/json:
              schema:
                type: "object"
                properties:
                  message:
                    type: "string"
                    example: "Role changed successfully!"
        
        400:
          description: Invalid data
          content:
            application/json:
              schema:
                type: "object"
                properties:
                  message:
                    type: "string"
                    example: "Invalid form data!"
        
        404:
          description: Not found
          content:
            application/json:
              schema:
                type: "object"
                properties:
                  message:
                    type: "string"
                    example: "User not found"
                    
        422:
          description: Invalid key
          content:
            application/json:
              schema:
                type: "object"
                properties:
                  message:
                    type: "string"
                    example: "Invalid key"
          

components:

  securitySchemes:
    jwt_auth:
      type: apiKey
      in: header
      name: Authorization

    admin_auth:
      type: apiKey
      in: header
      name: Authorization
      
    db_key:
      type: apiKey
      in: header
      name: Authorization
      
  schemas:

    Statistics:
      type: object
      properties:
        averageTime:
          type: number
          example: 0.00031381000000000003
        rowCount:
          type: integer
          example: 3  

    Processes:
      type: array
      items:
        type: object
        properties:
          ID:
            type: integer
          CreatedAt:
            type: string
            format: date-time
          UpdatedAt:
            type: string
            format: date-time
          DeletedAt:
            type: string
            format: date-time
            nullable: true
          Time:
            type: integer
          UserID:
            type: integer
          FileName:
            type: string
          Routines:
            type: integer
          ProcessData:
            type: object
            properties:
              ID:
                type: integer
              CreatedAt:
                type: string
                format: date-time
              UpdatedAt:
                type: string
                format: date-time
              DeletedAt:
                type: string
                format: date-time
                nullable: true
              LineCount:
                type: integer
              WordsCount:
                type: integer
              VowelsCount:
                type: integer
              PunctuationCount:
                type: integer
              ProcessID:
                type: integer

  
    Migration:
      type: "object"
      properties:
        message:
          type: "string"
          example: "Migrations completed successfully"
        
    ErrorModel:
      type: "object"
      properties:
        message:
          type: "string"
          example: "Error Message"
        
        
        
                                      # END FILE