openapi: 3.2.0
info:
  version: v2.222.1
  title: Corva Projects 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: Projects
paths:
  /v2/projects:
    get:
      summary: List Projects
      tags:
      - Projects
      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/ProjectList'
      parameters:
      - in: query
        name: page
        description: Number of page
        schema:
          type: integer
      - in: query
        name: per_page
        description: Number of items to list per page
        schema:
          type: integer
      - in: query
        name: sort
        description: 'One or more fields to sort by. Prefix with a - for descending order. Ex: name,-updated_at'
        schema:
          type: string
          enum:
          - status
          - created_at
          - updated_at
          default: updated_at
      - in: query
        name: order
        description: A sorting direction
        schema:
          type: string
          enum:
          - asc
          - desc
          default: desc
      - in: query
        name: status
        description: Filter by status
        schema:
          type: string
          enum:
          - active
          - archived
      operationId: getV2Projects
      x-operation-id-source: derived
    post:
      summary: Create a Project
      tags:
      - Projects
      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: Created Project
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectObject'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProjectPayload'
        description: Project Payload
        required: true
      operationId: postV2Projects
      x-operation-id-source: derived
  /v2/projects/{id}:
    get:
      summary: Show Project
      tags:
      - Projects
      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/ProjectObject'
      parameters:
      - in: path
        name: id
        description: Project ID
        required: true
        schema:
          type: integer
          format: int64
      operationId: getV2ProjectsById
      x-operation-id-source: derived
    patch:
      summary: Update a Project
      tags:
      - Projects
      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 Project
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectObject'
      parameters:
      - in: path
        name: id
        description: Project ID
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProjectPayload'
        description: Project Payload
        required: true
      operationId: patchV2ProjectsById
      x-operation-id-source: derived
    delete:
      summary: Delete a Project
      tags:
      - Projects
      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: Project deleted
      parameters:
      - in: path
        name: id
        description: Project ID
        required: true
        schema:
          type: integer
      operationId: deleteV2ProjectsById
      x-operation-id-source: derived
    post:
      summary: Clone a Project
      tags:
      - Projects
      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: Cloned Project
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectObject'
      parameters:
      - in: path
        name: id
        description: Project ID
        required: true
        schema:
          type: integer
          format: int64
      operationId: postV2ProjectsById
      x-operation-id-source: derived
components:
  schemas:
    ProjectList:
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ProjectObject'
        included:
          type: array
          items:
            properties:
              id:
                type: integer
              type:
                type: string
              attributes:
                type: object
      example:
        data:
        - id: 12345
          type: project
          attributes:
            id: 12345
            name: Project Name
            status: active
            user_id: 348
            description: Project description text
            settings:
              foo: bar
            dependencies:
              flask: 1
              python3: 1
            created_at: '2022-11-11T09:11:52.326Z'
            updated_at: '2022-11-11T09:11:52.326Z'
          relationships: {}
        included: []
    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.
    ProjectPayload:
      properties:
        project:
          type: object
          properties:
            name:
              type: string
            status:
              type: string
            description:
              type: text
            settings:
              type: object
            dependencies:
              type: object
      example:
        project:
          name: Project name
          status: active
          description: Project description text
          settings:
            foo: bar
          dependencies:
            flask: 1
            python3: 1
    NotFoundError:
      required:
      - code
      - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
      example:
        code: 404
        message: Not found
    ProjectObject:
      properties:
        data:
          type: object
          properties:
            id:
              type: integer
              format: int64
            type:
              type: string
            attributes:
              type: object
              properties:
                id:
                  type: integer
                  format: int64
                name:
                  type: string
                status:
                  type: string
                user_id:
                  type: integer
                  format: int64
                description:
                  type: text
                settings:
                  type: object
                dependencies:
                  type: object
                created_at:
                  type: string
                  format: date-time
                updated:
                  type: string
                  format: date-time
            relationships:
              type: object
        included:
          type: array
          items:
            properties:
              id:
                type: integer
              type:
                type: string
              attributes:
                type: object
      example:
        data:
          id: 12345
          type: project
          attributes:
            id: 12345
            name: Project Name
            status: active
            user_id: 348
            description: Project description text
            settings:
              foo: bar
            dependencies:
              flask: 1
              python3: 1
            created_at: '2022-11-11T09:11:52.326Z'
            updated_at: '2022-11-11T09:11:52.326Z'
          relationships:
            user:
              data:
                id: 348
                type: user
        included:
        - id: 348
          type: user
          attributes:
            id: 348
            first_name: John
            last_name: Doe
            email: jo.doe@example.com
            created_at: '2022-11-11T09:11:52.326Z'
            updated_at: '2022-11-11T09:11:52.326Z'
  securitySchemes:
    api_key:
      type: apiKey
      name: authorization
      in: header