openapi: 3.2.0
info:
  version: v2.222.1
  title: Corva App Connection API
  description: 'The Corva API is a powerful interface providing great flexibility and extensibility with Corva. Whether your needs are simple UI visualizations, data entry, replication/sync tasks, real-time stream processing, or complex machine learning CPU-intensive apps, the Corva API is the way to make it happen. Our concepts are split into three distinct silos: data apps, visualization apps, and a REST API'
  termsOfService: https://www.corva.ai/terms-and-conditions/
  contact:
    name: Corva API Team
    email: support@corva.ai
security:
- api_key: []
tags:
- name: AppConnection
paths:
  /v1/app_connections:
    post:
      summary: Create AppConnection
      tags:
      - AppConnection
      responses:
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '403':
          description: Authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationError'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '200':
          type: object
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppConnectionResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppConnectionPayload'
        description: AppConnection
        required: true
      operationId: postV1AppConnections
      x-operation-id-source: derived
  /v1/app_connections/{id}:
    get:
      summary: Show AppConnection
      tags:
      - AppConnection
      responses:
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '403':
          description: Authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationError'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '200':
          type: object
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppConnectionResponse'
      parameters:
      - in: path
        name: id
        description: AppConnection ID
        required: true
        schema:
          type: integer
          format: int64
      operationId: getV1AppConnectionsById
      x-operation-id-source: derived
    patch:
      summary: Update AppConnection
      tags:
      - AppConnection
      responses:
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '403':
          description: Authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationError'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '200':
          type: object
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppConnectionResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppConnectionPayload'
        description: AppConnection
        required: true
      operationId: patchV1AppConnectionsById
      x-operation-id-source: derived
    delete:
      summary: Delete AppConnection
      tags:
      - AppConnection
      responses:
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '403':
          description: Authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationError'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '200':
          description: AppConnection deleted
      parameters:
      - in: path
        name: id
        description: AppConnection ID
        required: true
        schema:
          type: integer
          format: int64
      operationId: deleteV1AppConnectionsById
      x-operation-id-source: derived
  /v1/app_connections/{id}/update_package:
    patch:
      summary: Update package version for AppConnection
      tags:
      - AppConnection
      responses:
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '403':
          description: Authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationError'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '200':
          description: Updated AppStream
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppConnectionResponse'
      requestBody:
        content:
          application/json:
            schema: {}
        description: Package version number
        required: true
      operationId: patchV1AppConnectionsByIdUpdatePackage
      x-operation-id-source: derived
components:
  schemas:
    AppConnectionResponse:
      properties:
        id:
          type: integer
          format: int64
        app_id:
          type: integer
          format: int64
        settings:
          type: object
        status:
          type: string
        scheduler_type:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        next_schedule_check_at:
          type: string
          format: date-time
        package_version:
          type: string
        code_version:
          type: string
        notes:
          type: string
        app:
          type: object
        company:
          type: object
      example:
        id: 123
        app_id: 10
        settings: {}
        status: idle
        scheduler_type: no_scheduler
        created_at: '2020-01-01T08:00:00.000Z'
        updated_at: '2020-01-01T08:00:00.000Z'
        next_schedule_check_at: '2020-01-01T08:00:00.000Z'
        package_version: 1.0.0
        code_version: '3'
        notes: Notes
        app: {}
        company: {}
    AuthorizationError:
      required:
      - code
      - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
      example:
        code: 403
        message: Access denied
    AuthenticationError:
      required:
      - code
      - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
      example:
        code: 401
        message: Missing authentication. Please try again.
    NotFoundError:
      required:
      - code
      - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
      example:
        code: 404
        message: Not found
    AppConnectionPayload:
      properties:
        status:
          type: string
        app_id:
          type: integer
        app_stream_id:
          type: integer
        next_schedule_check_at:
          type: string
        settings:
          type: object
      example:
        status: corva
        app_id: drilling-roadmap
        app_stream_id: 2342
        next_schedule_check_at: '2020-01-01T08:00:00.000Z'
        settings:
          visibility: public
  securitySchemes:
    api_key:
      type: apiKey
      name: authorization
      in: header