openapi: 3.1.0
info:
  title: Oracle Container Engine for Kubernetes (OKE) Add-ons Work Requests API
  description: Oracle Container Engine for Kubernetes (OKE) is a managed Kubernetes service on Oracle Cloud Infrastructure. The API exposes endpoints for managing Kubernetes clusters, node pools, virtual node pools, add-ons, work requests, and cluster credentials within OCI compartments.
  version: 20180222
  contact:
    name: Oracle Cloud Infrastructure Support
    url: https://support.oracle.com
  license:
    name: Oracle Cloud Services Agreement
    url: https://www.oracle.com/cloud/cloud-services-agreements/
servers:
- url: https://containerengine.{region}.oci.oraclecloud.com/20180222
  description: OCI Container Engine regional endpoint
  variables:
    region:
      default: us-ashburn-1
      description: OCI region identifier
security:
- ociAuth: []
tags:
- name: Work Requests
  description: Asynchronous operation tracking
paths:
  /workRequests:
    get:
      tags:
      - Work Requests
      summary: List work requests
      operationId: listWorkRequests
      parameters:
      - $ref: '#/components/parameters/CompartmentId'
      - name: resourceId
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Work request list
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WorkRequestSummary'
  /workRequests/{workRequestId}:
    get:
      tags:
      - Work Requests
      summary: Get a work request
      operationId: getWorkRequest
      parameters:
      - name: workRequestId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Work request details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkRequest'
components:
  schemas:
    WorkRequestSummary:
      type: object
      properties:
        id:
          type: string
        operationType:
          type: string
        status:
          type: string
          enum:
          - ACCEPTED
          - IN_PROGRESS
          - FAILED
          - SUCCEEDED
          - CANCELING
          - CANCELED
        compartmentId:
          type: string
        resources:
          type: array
          items:
            type: object
            properties:
              actionType:
                type: string
              entityType:
                type: string
              identifier:
                type: string
        timeAccepted:
          type: string
          format: date-time
        timeStarted:
          type: string
          format: date-time
        timeFinished:
          type: string
          format: date-time
    WorkRequest:
      $ref: '#/components/schemas/WorkRequestSummary'
  parameters:
    CompartmentId:
      name: compartmentId
      in: query
      required: true
      schema:
        type: string
      description: OCID of the compartment
  securitySchemes:
    ociAuth:
      type: apiKey
      in: header
      name: Authorization
      description: OCI request signing (RFC 7615) using API key pair
externalDocs:
  description: OCI Container Engine API Reference
  url: https://docs.oracle.com/en-us/iaas/api/#/en/containerengine/