openapi: 3.2.0
info:
  version: v2.222.1
  title: Corva Well Plan Checklists 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: Well Plan Checklists
  description: Manage well plan checklists
paths:
  /v2/well_plan_checklists:
    get:
      summary: List well plan checklists
      tags:
      - Well Plan Checklists
      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/WellPlanChecklistV2List'
      parameters:
      - in: query
        name: company_id
        description: Filter by company ID
        required: false
        schema:
          type: integer
          format: int64
      - in: query
        name: per_page
        description: Number of items to list per page
        required: false
        schema:
          type: integer
      - in: query
        name: page
        description: Page number
        required: false
        schema:
          type: integer
      operationId: getV2WellPlanChecklists
      x-operation-id-source: derived
  /v2/well_plan_checklists/{id}:
    get:
      summary: Show well plan checklist
      tags:
      - Well Plan Checklists
      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/WellPlanChecklistV2Response'
      parameters:
      - in: path
        name: id
        description: Well Plan Checklist ID
        required: true
        schema:
          type: integer
          format: int64
      operationId: getV2WellPlanChecklistsById
      x-operation-id-source: derived
components:
  schemas:
    AuthorizationError:
      required:
      - code
      - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
      example:
        code: 403
        message: Access denied
    WellPlanChecklistV2Response:
      properties:
        data:
          $ref: '#/components/schemas/WellPlanChecklistV2'
    WellPlanChecklistV2List:
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/WellPlanChecklistV2'
    WellPlanChecklistV2:
      properties:
        id:
          type: integer
          format: int64
        type:
          type: string
        attributes:
          type: object
          properties:
            id:
              type: integer
              format: int64
            name:
              type: string
            company_id:
              type: integer
              format: int64
            position:
              type: integer
            created_at:
              type: string
              format: date-time
            updated_at:
              type: string
              format: date-time
        relationships:
          type: object
          properties:
            company:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                      format: int64
                    type:
                      type: string
      example:
        id: 12345
        type: well_plan_checklist
        attributes:
          id: 12345
          name: Pre-spud
          company_id: 1
          position: 0
          created_at: '2026-06-18T08:00:00.000Z'
          updated_at: '2026-06-18T08:00:00.000Z'
        relationships:
          company:
            data:
              id: '1'
              type: company
    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
  securitySchemes:
    api_key:
      type: apiKey
      name: authorization
      in: header