openapi: 3.2.0
info:
  version: v2.222.1
  title: Corva Project Folders 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: ProjectFolders
paths:
  /v2/projects/{project_id}/project_folders:
    get:
      summary: List ProjectFolders
      tags:
      - ProjectFolders
      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/ProjectFolderList'
      parameters:
      - in: path
        name: project_id
        description: Project ID
        required: true
        schema:
          type: integer
          format: int64
      - 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:
          - name
          - created_at
          - updated_at
          default: name
      - in: query
        name: order
        description: A sorting direction
        schema:
          type: string
          enum:
          - asc
          - desc
          default: asc
      operationId: getV2ProjectsByProjectIdProjectFolders
      x-operation-id-source: derived
    post:
      summary: Create a ProjectFolder
      tags:
      - ProjectFolders
      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 ProjectFolder
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectFolderObject'
      parameters:
      - in: path
        name: project_id
        description: Project ID
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProjectFolderPayload'
        description: ProjectFolder Payload
        required: true
      operationId: postV2ProjectsByProjectIdProjectFolders
      x-operation-id-source: derived
  /v2/projects/{project_id}/project_folders/{id}:
    get:
      summary: Show ProjectFolder
      tags:
      - ProjectFolders
      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/ProjectFolderObject'
      parameters:
      - in: path
        name: project_id
        description: Project ID
        required: true
        schema:
          type: integer
          format: int64
      - in: path
        name: id
        description: ProjectFolder ID
        required: true
        schema:
          type: integer
          format: int64
      operationId: getV2ProjectsByProjectIdProjectFoldersById
      x-operation-id-source: derived
    patch:
      summary: Update a ProjectFolder
      tags:
      - ProjectFolders
      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 ProjectFolder
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectFolderObject'
      parameters:
      - in: path
        name: project_id
        description: Project ID
        required: true
        schema:
          type: integer
          format: int64
      - in: path
        name: id
        description: ProjectFolder ID
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProjectFolderPayload'
        description: ProjectFolder Payload
        required: true
      operationId: patchV2ProjectsByProjectIdProjectFoldersById
      x-operation-id-source: derived
    delete:
      summary: Delete a ProjectFolder
      tags:
      - ProjectFolders
      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: ProjectFolder deleted
      parameters:
      - in: path
        name: project_id
        description: Project ID
        required: true
        schema:
          type: integer
          format: int64
      - in: path
        name: id
        description: ProjectFolder ID
        required: true
        schema:
          type: integer
      operationId: deleteV2ProjectsByProjectIdProjectFoldersById
      x-operation-id-source: derived
components:
  schemas:
    ProjectFolderList:
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ProjectFolderObject'
        included:
          type: array
          items:
            properties:
              id:
                type: integer
              type:
                type: string
              attributes:
                type: object
      example:
        data:
        - id: 12345
          type: project_folder
          attributes:
            id: 12345
            name: Folder Name
            parent_project_folder_id: 12346
            created_at: '2022-11-11T09:11:52.326Z'
            updated_at: '2022-11-11T09:11:52.326Z'
          relationships: {}
        included: []
    ProjectFolderObject:
      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
                parent_project_folder_id:
                  type: integer
                  format: int64
                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_folder
          attributes:
            id: 12345
            name: Folder Name
            parent_project_folder_id: 12346
            created_at: '2022-11-11T09:11:52.326Z'
            updated_at: '2022-11-11T09:11:52.326Z'
          relationships:
            project:
              data:
                id: 348
                type: project
            sub_project_folders:
              data:
              - id: 1
                type: project_folder
        included:
        - id: 348
          type: project
          attributes:
            id: 348
            name: Project Name
            status: active
            description: Project description
            created_at: '2022-11-11T09:11:52.326Z'
            updated_at: '2022-11-11T09:11:52.326Z'
        - id: 1
          type: project_folder
          attributes:
            id: 348
            name: Sub Folder for Folder Name
            parent_project_folder_id: 12345
            created_at: '2022-11-11T09:11:52.326Z'
            updated_at: '2022-11-11T09:11:52.326Z'
    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
    ProjectFolderPayload:
      properties:
        project_folder:
          type: object
          properties:
            name:
              type: string
            parent_project_folder_id:
              type: integer
      example:
        project_folder:
          name: Folder name
          parent_project_folder_id: 111
  securitySchemes:
    api_key:
      type: apiKey
      name: authorization
      in: header