openapi: 3.2.0
info:
  version: v2.222.1
  title: Corva Frac Fleet Contracts 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: FracFleetContracts
paths:
  /v2/frac_fleets/{frac_fleet_id}/frac_fleet_contracts:
    get:
      summary: List Company Goals if no filters applied
      tags:
      - FracFleetContracts
      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: List of Frac Fleet Contracts
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FracFleetContract'
      parameters:
      - in: path
        name: frac_fleet_id
        description: Frac Fleet ID
        schema:
          type: integer
          format: int64
        required: true
      - in: query
        name: per_page
        description: Number of items to list per page
        schema:
          type: integer
      - in: query
        name: page
        description: Number of page
        schema:
          type: integer
      operationId: getV2FracFleetsByFracFleetIdFracFleetContracts
      x-operation-id-source: derived
    post:
      summary: Create Frac Fleet Contract
      tags:
      - FracFleetContracts
      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 Frac Fleet Contract
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FracFleetContract'
      parameters:
      - in: path
        name: frac_fleet_id
        description: Frac Fleet ID
        schema:
          type: integer
          format: int64
        required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FracFleetContractCreatePayload'
        description: Frac Fleet Contract Payload
        required: true
      operationId: postV2FracFleetsByFracFleetIdFracFleetContracts
      x-operation-id-source: derived
  /v2/frac_fleets/{frac_fleet_id}/frac_fleet_contracts/{id}:
    get:
      summary: List Company Goals if no filters applied
      tags:
      - FracFleetContracts
      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: Frac Fleet Contract
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FracFleetContract'
      parameters:
      - in: path
        name: frac_fleet_id
        description: Frac Fleet ID
        schema:
          type: integer
          format: int64
        required: true
      - in: path
        name: id
        description: Frac Fleet Contract ID
        schema:
          type: integer
          format: int64
        required: true
      operationId: getV2FracFleetsByFracFleetIdFracFleetContractsById
      x-operation-id-source: derived
    patch:
      summary: Update Frac Fleet Contract
      tags:
      - FracFleetContracts
      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: Frac Fleet Contract
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FracFleetContract'
      parameters:
      - in: path
        name: frac_fleet_id
        description: Frac Fleet ID
        schema:
          type: integer
          format: int64
        required: true
      - in: path
        name: id
        description: Frac Fleet Contract ID
        schema:
          type: integer
          format: int64
        required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FracFleetContractUpdatePayload'
        description: Frac Fleet Contract Payload
        required: true
      operationId: patchV2FracFleetsByFracFleetIdFracFleetContractsById
      x-operation-id-source: derived
    delete:
      summary: Delete Frac Fleet Contract
      tags:
      - FracFleetContracts
      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: Deleted Frac Fleet Contract
          content:
            application/json:
              schema:
                example:
                  status: deleted
      parameters:
      - in: path
        name: frac_fleet_id
        description: Frac Fleet ID
        schema:
          type: integer
          format: int64
        required: true
      - in: path
        name: id
        description: Frac Fleet Contract ID
        schema:
          type: integer
          format: int64
        required: true
      operationId: deleteV2FracFleetsByFracFleetIdFracFleetContractsById
      x-operation-id-source: derived
components:
  schemas:
    FracFleetContractUpdatePayload:
      properties:
        frac_fleet_contract:
          type: object
          properties:
            current:
              type: boolean
            data:
              type: object
      example:
        frac_fleet_contract:
          current: true
          data:
            key: value
            another_key: another_value
    AuthorizationError:
      required:
      - code
      - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
      example:
        code: 403
        message: Access denied
    NotFoundError:
      required:
      - code
      - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
      example:
        code: 404
        message: Not found
    FracFleetContract:
      properties:
        id:
          type: integer
          format: int64
        type:
          type: string
        attributes:
          type: object
          properties:
            id:
              type: integer
              format: int64
            current:
              type: boolean
            data:
              type: object
            created_at:
              type: string
              format: date-time
            updated_at:
              type: string
              format: date-time
      example:
        id: 123
        type: frac_fleet_contract
        attributes:
          id: 123
          current: true
          data:
            key: value
            another_key: another_value
          created_at: '2020-01-01T08:00:00.000Z'
          updated_at: '2020-01-01T08:00:00.000Z'
    AuthenticationError:
      required:
      - code
      - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
      example:
        code: 401
        message: Missing authentication. Please try again.
    FracFleetContractCreatePayload:
      properties:
        frac_fleet_contract:
          type: object
          properties:
            current:
              type: boolean
            data:
              type: object
      example:
        frac_fleet_contract:
          current: true
          data:
            key: value
            another_key: another_value
  securitySchemes:
    api_key:
      type: apiKey
      name: authorization
      in: header