openapi: 3.2.0
info:
  title: Audatex.APIGateway Job 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: Job
paths:
  /api/v1/Job:
    post:
      tags:
      - Job
      summary: Add a Job associated to an EntityId
      description: ''
      requestBody:
        description: ''
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/JobReqViewModel'
          application/json:
            schema:
              $ref: '#/components/schemas/JobReqViewModel'
          text/json:
            schema:
              $ref: '#/components/schemas/JobReqViewModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/JobReqViewModel'
      responses:
        '201':
          description: Returns a created response
        '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
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '403':
          description: Returns an error if the user has not the permissions needed
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '500':
          description: Sorry, an unexpected error has occurred
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
      operationId: postApiV1Job
      x-operation-id-source: derived
    get:
      tags:
      - Job
      summary: Get the job list
      description: This endpoint will allow you to get the Job List
      responses:
        '200':
          description: Returns the job list
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/JobResViewModel'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/JobResViewModel'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/JobResViewModel'
        '400':
          description: Returns an error if the request fails validation
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '401':
          description: Returns an error if the user is not authorised
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '403':
          description: Returns an error if the user has not the permissions needed
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '500':
          description: Sorry, an unexpected error has occurred
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
      operationId: getApiV1Job
      x-operation-id-source: derived
  /api/v1/Job/{id}:
    get:
      tags:
      - Job
      summary: Get the job for a given id
      description: This endpoint will allow you to get the Job for an Id
      parameters:
      - name: id
        in: path
        description: jobId
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Returns the job for the id
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/JobResViewModel'
            application/json:
              schema:
                $ref: '#/components/schemas/JobResViewModel'
            text/json:
              schema:
                $ref: '#/components/schemas/JobResViewModel'
        '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
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '403':
          description: Returns an error if the user has not the permissions needed
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '404':
          description: Returns an error if the job do not exist
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '500':
          description: Sorry, an unexpected error has occurred
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
      operationId: getApiV1JobById
      x-operation-id-source: derived
  /api/v1/Job/{jobId}:
    put:
      tags:
      - Job
      summary: Update the job
      description: This endpoint will allow you to update the Job
      parameters:
      - name: jobId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/JobReqViewModel'
          application/json:
            schema:
              $ref: '#/components/schemas/JobReqViewModel'
          text/json:
            schema:
              $ref: '#/components/schemas/JobReqViewModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/JobReqViewModel'
      responses:
        '204':
          description: Returns no content
        '400':
          description: Returns a bad request if there is no job
          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 authorized
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '403':
          description: Returns an error if the user has not the permissions needed
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '404':
          description: Returns an error if any job do not exist
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '500':
          description: Returns an error if any job cannot be updated
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
      operationId: putApiV1JobByJobId
      x-operation-id-source: derived
    delete:
      tags:
      - Job
      summary: Delete Job
      description: This endpoint will allow you to delete a job.
      parameters:
      - name: jobId
        in: path
        description: ''
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '202':
          description: Returns an accepted response
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '204':
          description: Returns an NoContent response
        '401':
          description: Returns an error if the user is not authorized
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '403':
          description: Returns an error if the user has not the permissions needed
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '404':
          description: Returns an error if the job does not exist
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '500':
          description: Sorry, an unexpected error has occurred
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
      operationId: deleteApiV1JobByJobId
      x-operation-id-source: derived
components:
  schemas:
    JobReqViewModel:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          maxLength: 50
          type:
          - string
          - 'null'
      additionalProperties: false
    JobResViewModel:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type:
          - string
          - 'null'
      additionalProperties: false
  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