openapi: 3.2.0
info:
  title: Audatex.APIGateway Video API
  termsOfService: https://www.solera.com/legal/
  contact:
    name: Solera Development Team
    url: https://docs.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-2.2&tabs=visual-studio
    email: development@solera.com
  license:
    name: License
    url: https://www.solera.com/legal/
  version: V1
servers:
- url: /APIGateway
security:
- Bearer: []
- Bearer: []
tags:
- name: Video
paths:
  /api/v1/Video:
    post:
      tags:
      - Video
      summary: Upload a File
      description: This endpoint will allow a file to be uploaded
      responses:
        '201':
          description: Returns a created response with the imageId
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SelfViewModel'
            application/json:
              schema:
                $ref: '#/components/schemas/SelfViewModel'
            text/json:
              schema:
                $ref: '#/components/schemas/SelfViewModel'
        '400':
          description: Returns an error if the request fails validation
          content:
            text/plain:
              schema:
                type: object
                additionalProperties:
                  type: string
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
            text/json:
              schema:
                type: object
                additionalProperties:
                  type: string
        '500':
          description: Sorry, an unexpected error has occurred
        '401':
          description: Returns an error if the user is not authorised
      operationId: postApiV1Video
      x-operation-id-source: derived
    get:
      tags:
      - Video
      summary: Get content of a file by fileId
      description: This API will allow you to get a file stream
      parameters:
      - name: fileId
        in: query
        description: The id of the file
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Returns the file stream
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Stream'
            application/json:
              schema:
                $ref: '#/components/schemas/Stream'
            text/json:
              schema:
                $ref: '#/components/schemas/Stream'
        '400':
          description: Returns an error if the request fails validation
          content:
            text/plain:
              schema:
                type: object
                additionalProperties:
                  type: string
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
            text/json:
              schema:
                type: object
                additionalProperties:
                  type: string
        '401':
          description: Returns an error if the user is not authorised
      operationId: getApiV1Video
      x-operation-id-source: derived
    delete:
      tags:
      - Video
      summary: delete content of a file by fileId
      description: This API will allow you to delete a file stream
      parameters:
      - name: fileId
        in: query
        description: The id of the file
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Returns the file stream
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Stream'
            application/json:
              schema:
                $ref: '#/components/schemas/Stream'
            text/json:
              schema:
                $ref: '#/components/schemas/Stream'
        '400':
          description: Returns an error if the request fails validation
          content:
            text/plain:
              schema:
                type: object
                additionalProperties:
                  type: string
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
            text/json:
              schema:
                type: object
                additionalProperties:
                  type: string
        '401':
          description: Returns an error if the user is not authorised
      operationId: deleteApiV1Video
      x-operation-id-source: derived
  /api/v1/Video/Info:
    post:
      tags:
      - Video
      summary: Create a file space in the service to be used to upload a file stream
      description: This endpoint will create the file data necessary in DB to upload a file
      requestBody:
        description: ''
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/FileModel'
          application/json:
            schema:
              $ref: '#/components/schemas/FileModel'
          text/json:
            schema:
              $ref: '#/components/schemas/FileModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/FileModel'
      responses:
        '201':
          description: Returns a created response with the fileId
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SelfViewModel'
            application/json:
              schema:
                $ref: '#/components/schemas/SelfViewModel'
            text/json:
              schema:
                $ref: '#/components/schemas/SelfViewModel'
        '400':
          description: Returns an error if the request fails validation
          content:
            text/plain:
              schema:
                type: object
                additionalProperties:
                  type: string
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
            text/json:
              schema:
                type: object
                additionalProperties:
                  type: string
        '500':
          description: Sorry, an unexpected error has occurred
        '401':
          description: Returns an error if the user is not authorised
      operationId: postApiV1VideoInfo
      x-operation-id-source: derived
components:
  schemas:
    FileModel:
      type: object
      properties:
        filename:
          maxLength: 200
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
        type:
          $ref: '#/components/schemas/FileType'
        collectionId:
          type:
          - string
          - 'null'
          format: uuid
      additionalProperties: false
    Stream:
      type: object
      properties:
        canRead:
          type: boolean
          readOnly: true
        canWrite:
          type: boolean
          readOnly: true
        canSeek:
          type: boolean
          readOnly: true
        canTimeout:
          type: boolean
          readOnly: true
        length:
          type: integer
          format: int64
          readOnly: true
        position:
          type: integer
          format: int64
        readTimeout:
          type: integer
          format: int32
        writeTimeout:
          type: integer
          format: int32
      additionalProperties: false
    SelfViewModel:
      type: object
      properties:
        id:
          type: string
          format: uuid
        self:
          type:
          - string
          - 'null'
      additionalProperties: false
    FileType:
      enum:
      - MP4
      - AVI
      - MOV
      - WAV
      type: string
  securitySchemes:
    Bearer:
      type: apiKey
      description: "JWT Authorization header using the Bearer scheme. \n\n Enter 'Bearer' [space] and then your token in the text input below.\n\nExample: \"Bearer 12345abcdef\""
      name: Authorization
      in: header