API Evangelist conversational phrasing for Cloudera Service Compute API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cloudera Service Compute API
  version: 1.0.0
extends: openapi/cloudera-compute-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 15
- target: $.paths['/api/v1/compute/createCluster'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a compute cluster
      effect: write
      questions:
      - How do I create a new compute cluster in a CDP environment?
      - Can I skip validation or set network options when creating a compute cluster?
      instructions:
      - text: Create a compute cluster named {name} in environment {environment}.
        slots:
          name: requestBody.name
          environment: requestBody.environment
      - text: Create compute cluster {name} in {environment} with network settings {network} and tags {tags}.
        slots:
          name: requestBody.name
          environment: requestBody.environment
          network: requestBody.network
          tags: requestBody.tags
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/compute/deleteCluster'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a compute cluster
      effect: destructive
      questions:
      - Can I force-delete a compute cluster that still has workloads on it?
      - What do I need to tear down a compute cluster?
      instructions:
      - text: Delete compute cluster {clusterCrn}.
        slots:
          clusterCrn: requestBody.clusterCrn
      - text: Force delete compute cluster {clusterCrn}, skipping workload validation.
        slots:
          clusterCrn: requestBody.clusterCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/compute/describeCluster'].post
  update:
    x-apievangelist-phrasing:
      intent: Get details of a compute cluster
      effect: read
      questions:
      - What are the details and current state of one of my compute clusters?
      - Can I inspect a compute cluster's configuration by its CRN?
      instructions:
      - text: Describe compute cluster {clusterCrn}.
        slots:
          clusterCrn: requestBody.clusterCrn
      - text: Show me the details of the compute cluster {clusterCrn}.
        slots:
          clusterCrn: requestBody.clusterCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/compute/describeDeployment'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a deployment and its history
      effect: read
      questions:
      - What is the history of a specific Helm deployment on my compute cluster?
      - Can I see the templates for one deployment in a cluster namespace?
      instructions:
      - text: Describe deployment {name} in namespace {namespace} on cluster {clusterCrn}.
        slots:
          name: requestBody.name
          namespace: requestBody.namespace
          clusterCrn: requestBody.clusterCrn
      - text: Show the extended history of deployment {name} in {namespace} on compute cluster {clusterCrn}.
        slots:
          name: requestBody.name
          namespace: requestBody.namespace
          clusterCrn: requestBody.clusterCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/compute/getOperationDetails'].post
  update:
    x-apievangelist-phrasing:
      intent: Get full details of a long-running operation
      effect: read
      questions:
      - Where can I see detailed step information for a long-running compute operation?
      - Can I look up the details of a specific run of an operation?
      instructions:
      - text: Get detailed information for compute operation {operationId}.
        slots:
          operationId: requestBody.operationId
      - text: Show the full details of run {runId} of operation {operationId}.
        slots:
          runId: requestBody.runId
          operationId: requestBody.operationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/compute/getOperationStatus'].post
  update:
    x-apievangelist-phrasing:
      intent: Check status of a long-running operation
      effect: read
      questions:
      - Is my long-running compute operation finished yet?
      - What's a lightweight way to poll the status of a compute operation?
      instructions:
      - text: Check the status of compute operation {operationId}.
        slots:
          operationId: requestBody.operationId
      - text: Poll whether operation {operationId} has completed.
        slots:
          operationId: requestBody.operationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/compute/listClusters'].post
  update:
    x-apievangelist-phrasing:
      intent: List compute clusters
      effect: read
      questions:
      - Which compute clusters are running in my CDP environment?
      - Can I filter compute clusters by status or include deleted ones?
      instructions:
      - text: List compute clusters in environment {envNameOrCrn}.
        slots:
          envNameOrCrn: requestBody.envNameOrCrn
      - text: List compute clusters with status {status}, including deleted ones.
        slots:
          status: requestBody.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/compute/listDeployments'].post
  update:
    x-apievangelist-phrasing:
      intent: List Helm deployments in a cluster
      effect: read
      questions:
      - Which Helm charts are deployed or available to deploy on my compute cluster?
      - Can I list deployments for just one namespace in a cluster?
      instructions:
      - text: List deployments on compute cluster {clusterCrn}.
        slots:
          clusterCrn: requestBody.clusterCrn
      - text: List the Helm deployments in namespace {namespace} on cluster {clusterCrn}.
        slots:
          namespace: requestBody.namespace
          clusterCrn: requestBody.clusterCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/compute/resumeCluster'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume a suspended compute cluster
      effect: write
      questions:
      - How do I bring a suspended compute cluster back online?
      - Can I resume a compute cluster without running validation first?
      instructions:
      - text: Resume compute cluster {clusterCrn}.
        slots:
          clusterCrn: requestBody.clusterCrn
      - text: Resume the suspended compute cluster {clusterCrn} and skip validation.
        slots:
          clusterCrn: requestBody.clusterCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/compute/retryOperation'].post
  update:
    x-apievangelist-phrasing:
      intent: Reset a failed operation for retry
      effect: write
      questions:
      - A compute cluster operation failed — can I reset it so it runs again?
      - What do I do to retry a failed long-running compute operation?
      instructions:
      - text: Reset failed operation {operationId} so it can be retried.
        slots:
          operationId: requestBody.operationId
      - text: Retry the failed compute operation {operationId}.
        slots:
          operationId: requestBody.operationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/compute/suspendCluster'].post
  update:
    x-apievangelist-phrasing:
      intent: Suspend a compute cluster
      effect: write
      questions:
      - Can I pause a compute cluster to save costs when it's not in use?
      - Is there a way to suspend a compute cluster even if workloads are running?
      instructions:
      - text: Suspend compute cluster {clusterCrn}.
        slots:
          clusterCrn: requestBody.clusterCrn
      - text: Suspend cluster {clusterCrn} without validating its workloads.
        slots:
          clusterCrn: requestBody.clusterCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/compute/updateCluster'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a compute cluster's spec
      effect: write
      questions:
      - How do I change the configuration of an existing compute cluster?
      - Why does updating a compute cluster need a cluster state version?
      instructions:
      - text: Update compute cluster {clusterCrn} with spec {spec} at state version {clusterStateVersion}.
        slots:
          clusterCrn: requestBody.clusterCrn
          spec: requestBody.spec
          clusterStateVersion: requestBody.clusterStateVersion
      - text: Apply the new spec {spec} to cluster {clusterCrn}, version {clusterStateVersion}.
        slots:
          spec: requestBody.spec
          clusterCrn: requestBody.clusterCrn
          clusterStateVersion: requestBody.clusterStateVersion
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/compute/upgradeCluster'].post
  update:
    x-apievangelist-phrasing:
      intent: Upgrade a compute cluster's Kubernetes version
      effect: write
      questions:
      - How do I upgrade Kubernetes on my compute cluster?
      - Can I dry-run a Kubernetes upgrade before applying it?
      instructions:
      - text: Upgrade the Kubernetes version of compute cluster {clusterCrn}.
        slots:
          clusterCrn: requestBody.clusterCrn
      - text: Do a dry run of the Kubernetes upgrade on cluster {clusterCrn}.
        slots:
          clusterCrn: requestBody.clusterCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/compute/upgradeDeployment'].post
  update:
    x-apievangelist-phrasing:
      intent: Upgrade a deployment to another chart version
      effect: write
      questions:
      - Can I move a Helm deployment on my compute cluster to a newer chart version?
      - Is it possible to pass value overrides when upgrading a deployment?
      instructions:
      - text: Upgrade deployment {name} in {namespace} on cluster {clusterCrn} to chart version {chartVersion}.
        slots:
          name: requestBody.name
          namespace: requestBody.namespace
          clusterCrn: requestBody.clusterCrn
          chartVersion: requestBody.chartVersion
      - text: Upgrade deployment {name} in {namespace} on {clusterCrn} with overrides {overrides}.
        slots:
          name: requestBody.name
          namespace: requestBody.namespace
          clusterCrn: requestBody.clusterCrn
          overrides: requestBody.overrides
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/compute/validateCluster'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a compute cluster before creating it
      effect: read
      questions:
      - Can I check whether a compute cluster definition is valid before I create it?
      - Will my planned compute cluster pass validation in this environment?
      instructions:
      - text: Validate compute cluster {name} for environment {environment}.
        slots:
          name: requestBody.name
          environment: requestBody.environment
      - text: Check that cluster {name} in {environment} with network {network} would pass validation.
        slots:
          name: requestBody.name
          environment: requestBody.environment
          network: requestBody.network
      method: generated
      generated: '2026-10-01'