openapi: 3.0.0
info:
  description: UCOATS Import specs
  version: 1.0.0
  title: UCOATS
servers:
  - url: 'https://dev-juan06.ctrl.ucla.edu/ucla-ws/ws/v1/import/'
    description: UCOATS Site
tags:
  - name: Upload 
    description: Endpoints to handle the upload of data
paths:
  '/app/faculty/exceptionFile/{upload_id}':
    get:
      tags:
        - Upload
      summary: Return annotated exception file for the import request
      description: Return annotated exception file for the import request
      parameters:
        - name: upload_id
          in: path
          description: the identifier for the file upload or word 'last'. 
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/exceptionFile'
    
  '/app/faculty/status/{upload_id}':
    get:
      tags:
        - Upload
      summary: Check on status of faculty import request 
      description: Check on status of faculty import request -
      parameters:
        - name: upload_id
          in: path
          description: the identifier for the file upload or word 'last'. 
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/status'
    
  '/app/faculty/upload':
    post:
      tags:
        - Upload
      summary: Check on status of faculty import request 
      description: Check on status of faculty import request -
      parameters:
        - name: file_upload
          in: header
          description: the faculty import file 
          required: true
          schema:
            type: string
        - name: fiscal_year
          in: header
          description: the fiscal year of the data. Format XXXX-YYYY
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/upload'

components:
  schemas:
    exceptionFile:
      type: object
      required:
        - response_code
        - response_message
        - response_body
      properties:
        response_code:
          type: string
          example: "VALIDATING"
        response_message:
          type: string
          example: "System is currently validating rows in the file"
        response_body:
          required:
            - upload_id
          properties:
            upload_id:
              type: string
              example: "123"
              
    status:
      type: object
      required:
        - response_code
        - response_message
        - response_body
      properties:
        response_code:
          type: string
          example: "COMPLETE_WITH_EXCEPTIONS"
        response_message:
          type: string
          example: "Some faculty records could not be processed"
        response_body:
          required:
            - upload_id
          properties:
            upload_id:
              type: string
              example: "123"
            records_failed:
              type: string
              example: "7"
            total_imported:
              type: string
              example: "3"
              
    upload:
      type: object
      required:
        - response_code
        - response_message
        - response_body
      properties:
        response_code:
          type: string
          example: "FILE_UPLOADED"
        response_message:
          type: string
          example: "File uploaded and validating now"
        response_body:
          required:
            - upload_id
          properties:
            upload_id:
              type: string
              example: "123"