API Evangelist conversational phrasing for Cloudera Data Engineering De 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 Data Engineering De API
  version: 1.0.0
extends: openapi/cloudera-de-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: 24
- target: $.paths['/api/v1/de/createBackup'].post
  update:
    x-apievangelist-phrasing:
      intent: Back up a Data Engineering service
      effect: write
      questions:
      - How do I back up my Cloudera Data Engineering service including its virtual clusters?
      - Can I choose where a CDE service backup is written?
      instructions:
      - text: Back up CDE service {serviceId}.
        slots:
          serviceId: requestBody.serviceId
      - text: Start a backup of CDE service {serviceId} to {backupPath} including virtual clusters set to {includeVc}.
        slots:
          serviceId: requestBody.serviceId
          backupPath: requestBody.backupPath
          includeVc: requestBody.includeVc
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/de/cancelBackup'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a pending CDE service backup
      effect: destructive
      questions:
      - Can I stop a CDE backup that hasn't finished yet?
      - Which backup states can be cancelled?
      instructions:
      - text: Cancel CDE backup {backupID}.
        slots:
          backupID: requestBody.backupID
      - text: Abort the pending service backup {backupID}.
        slots:
          backupID: requestBody.backupID
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/de/deleteBackup'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a CDE service backup
      effect: destructive
      questions:
      - How do I remove an old Data Engineering backup I no longer need?
      - Is deleting a CDE backup done by backup ID?
      instructions:
      - text: Delete CDE backup {backupID}.
        slots:
          backupID: requestBody.backupID
      - text: Permanently remove Data Engineering service backup {backupID}.
        slots:
          backupID: requestBody.backupID
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/de/describeBackup'].post
  update:
    x-apievangelist-phrasing:
      intent: Show details of a CDE service backup
      effect: read
      questions:
      - What's the status and content of a specific CDE backup?
      - Can I check whether my Data Engineering backup completed?
      instructions:
      - text: Describe CDE backup {backupID}.
        slots:
          backupID: requestBody.backupID
      - text: Show the status of Data Engineering backup {backupID}.
        slots:
          backupID: requestBody.backupID
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/de/getBackupLogs'].post
  update:
    x-apievangelist-phrasing:
      intent: Read the logs of a CDE backup
      effect: read
      questions:
      - Where can I see why a CDE service backup failed?
      - Are backup logs returned in pages?
      instructions:
      - text: Get the logs for CDE backup {backupID}.
        slots:
          backupID: requestBody.backupID
      - text: Fetch backup {backupID} log lines, {pageSize} per page.
        slots:
          backupID: requestBody.backupID
          pageSize: requestBody.pageSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/de/getServiceInitLogs'].post
  update:
    x-apievangelist-phrasing:
      intent: Read a CDE service's initialization logs
      effect: read
      questions:
      - Why did my Data Engineering service fail to come up?
      - Can I page through the startup logs of a CDE service?
      instructions:
      - text: Get the initialization logs for CDE service {serviceID}.
        slots:
          serviceID: requestBody.serviceID
      - text: Show startup logs of Data Engineering service {serviceID}.
        slots:
          serviceID: requestBody.serviceID
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/de/listBackups'].post
  update:
    x-apievangelist-phrasing:
      intent: List CDE service backups
      effect: read
      questions:
      - What Data Engineering backups do I have?
      - Can I sort or filter the list of CDE backups?
      instructions:
      - text: List all CDE service backups.
      - text: List CDE backups matching {filter} ordered by {orderBy}.
        slots:
          filter: requestBody.filter
          orderBy: requestBody.orderBy
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/de/restoreService'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore a CDE service from a backup
      effect: write
      questions:
      - How do I recover a Data Engineering service from a backup into an environment?
      - Can I give the restored CDE service a new name?
      instructions:
      - text: Restore CDE backup {backupID} into environment {environmentCrn}.
        slots:
          backupID: requestBody.backupID
          environmentCrn: requestBody.environmentCrn
      - text: Restore backup {backupID} to environment {environmentCrn} as service {serviceName}.
        slots:
          backupID: requestBody.backupID
          environmentCrn: requestBody.environmentCrn
          serviceName: requestBody.serviceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/de/createVc'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a CDE virtual cluster
      effect: write
      questions:
      - How do I create a virtual cluster for Spark jobs in Cloudera Data Engineering?
      - Can I set CPU and memory quotas and a Spark version on a new virtual cluster?
      instructions:
      - text: Create virtual cluster {name} in CDE service {clusterId} with {cpuRequests} CPU and {memoryRequests} memory.
        slots:
          name: requestBody.name
          clusterId: requestBody.clusterId
          cpuRequests: requestBody.cpuRequests
          memoryRequests: requestBody.memoryRequests
      - text: Create a Spark {sparkVersion} virtual cluster {name} on service {clusterId} with {cpuRequests} cores and {memoryRequests} memory.
        slots:
          sparkVersion: requestBody.sparkVersion
          name: requestBody.name
          clusterId: requestBody.clusterId
          cpuRequests: requestBody.cpuRequests
          memoryRequests: requestBody.memoryRequests
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/de/deleteVc'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a CDE virtual cluster
      effect: destructive
      questions:
      - How do I tear down a virtual cluster in Data Engineering?
      - What IDs do I need to delete a virtual cluster?
      instructions:
      - text: Delete virtual cluster {vcId} from CDE service {clusterId}.
        slots:
          vcId: requestBody.vcId
          clusterId: requestBody.clusterId
      - text: Remove VC {vcId} on service {clusterId}.
        slots:
          vcId: requestBody.vcId
          clusterId: requestBody.clusterId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/de/updateVc'].post
  update:
    x-apievangelist-phrasing:
      intent: Change access and Spark settings on a virtual cluster
      effect: write
      questions:
      - Can I change who has view-only or full access to an existing virtual cluster?
      - How do I update the Spark configs on a CDE virtual cluster?
      instructions:
      - text: Give groups {fullAccessGroups} full access to virtual cluster {vcId} on service {clusterId}.
        slots:
          fullAccessGroups: requestBody.fullAccessGroups
          vcId: requestBody.vcId
          clusterId: requestBody.clusterId
      - text: Update Spark configs on VC {vcId} in service {clusterId} to {sparkConfigs}.
        slots:
          vcId: requestBody.vcId
          clusterId: requestBody.clusterId
          sparkConfigs: requestBody.sparkConfigs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/de/describeService'].post
  update:
    x-apievangelist-phrasing:
      intent: Show a CDE service's details
      effect: read
      questions:
      - What's the configuration and status of my Data Engineering service?
      - Can I look up a CDE service by cluster ID?
      instructions:
      - text: Describe CDE service {clusterId}.
        slots:
          clusterId: requestBody.clusterId
      - text: Show the details of Data Engineering service {clusterId}.
        slots:
          clusterId: requestBody.clusterId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/de/describeVc'].post
  update:
    x-apievangelist-phrasing:
      intent: Show a virtual cluster's details
      effect: read
      questions:
      - What are the settings and status of one CDE virtual cluster?
      - Can I see the access lists configured on a virtual cluster?
      instructions:
      - text: Describe virtual cluster {vcId} in service {clusterId}.
        slots:
          vcId: requestBody.vcId
          clusterId: requestBody.clusterId
      - text: Show the configuration of VC {vcId} on CDE service {clusterId}.
        slots:
          vcId: requestBody.vcId
          clusterId: requestBody.clusterId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/de/disableService'].post
  update:
    x-apievangelist-phrasing:
      intent: Disable a Data Engineering service
      effect: destructive
      questions:
      - How do I shut down and remove a CDE service from an environment?
      - Can I force-disable a Data Engineering service that's stuck?
      instructions:
      - text: Disable CDE service {clusterId}.
        slots:
          clusterId: requestBody.clusterId
      - text: Force-disable Data Engineering service {clusterId} with force set to {force}.
        slots:
          clusterId: requestBody.clusterId
          force: requestBody.force
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/de/enableService'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable Data Engineering in an environment
      effect: write
      questions:
      - How do I turn on Cloudera Data Engineering in one of my environments?
      - Can I set min and max instance counts and an instance type when enabling CDE?
      instructions:
      - text: Enable CDE service {name} in environment {env} on {instanceType} with {minimumInstances} to {maximumInstances} instances.
        slots:
          name: requestBody.name
          env: requestBody.env
          instanceType: requestBody.instanceType
          minimumInstances: requestBody.minimumInstances
          maximumInstances: requestBody.maximumInstances
      - text: Enable Data Engineering {name} in {env} using {instanceType}, scaling {minimumInstances}-{maximumInstances}, with a public endpoint {enablePublicEndpoint}.
        slots:
          name: requestBody.name
          env: requestBody.env
          instanceType: requestBody.instanceType
          minimumInstances: requestBody.minimumInstances
          maximumInstances: requestBody.maximumInstances
          enablePublicEndpoint: requestBody.enablePublicEndpoint
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/de/updateService'].post
  update:
    x-apievangelist-phrasing:
      intent: Resize or re-allowlist a CDE service
      effect: write
      questions:
      - Can I change the autoscaling limits of a running Data Engineering service?
      - How do I update the IP allowlist on an existing CDE service?
      instructions:
      - text: Set CDE service {clusterId} to scale between {minimumInstances} and {maximumInstances} instances.
        slots:
          clusterId: requestBody.clusterId
          minimumInstances: requestBody.minimumInstances
          maximumInstances: requestBody.maximumInstances
      - text: Update the load balancer allowlist of service {clusterId} to {loadbalancerAllowlist}.
        slots:
          clusterId: requestBody.clusterId
          loadbalancerAllowlist: requestBody.loadbalancerAllowlist
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/de/upgradeService'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a step of a CDE service upgrade
      effect: write
      questions:
      - How do I upgrade my Data Engineering service step by step?
      - What upgrade steps can I trigger, like prepare, backup, upgrade and resume?
      instructions:
      - text: Run the {step} upgrade step on CDE service {clusterId}.
        slots:
          step: requestBody.step
          clusterId: requestBody.clusterId
      - text: Trigger the prepare step of the upgrade for service {clusterId}.
        slots:
          clusterId: requestBody.clusterId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/de/getUpgradeStatus'].post
  update:
    x-apievangelist-phrasing:
      intent: Check a CDE service upgrade's progress
      effect: read
      questions:
      - Which upgrade step should I run next on my Data Engineering service?
      - Has my CDE upgrade completed all its steps?
      instructions:
      - text: Get the upgrade status of CDE service {clusterId}.
        slots:
          clusterId: requestBody.clusterId
      - text: Tell me the next upgrade step for service {clusterId}.
        slots:
          clusterId: requestBody.clusterId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/de/getKubeconfig'].post
  update:
    x-apievangelist-phrasing:
      intent: Download a CDE service's kubeconfig
      effect: read
      questions:
      - How can I get kubectl access to the Kubernetes cluster behind a CDE service?
      - Is there a kubeconfig file for my Data Engineering service?
      instructions:
      - text: Get the kubeconfig for CDE service {clusterId}.
        slots:
          clusterId: requestBody.clusterId
      - text: Download kubectl credentials for Data Engineering service {clusterId}.
        slots:
          clusterId: requestBody.clusterId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/de/listServices'].post
  update:
    x-apievangelist-phrasing:
      intent: List Data Engineering services
      effect: read
      questions:
      - Which CDE services are running across my environments?
      - Can I hide deleted services when listing Data Engineering services?
      instructions:
      - text: List all CDE services.
      - text: List Data Engineering services with removeDeleted set to {removeDeleted}.
        slots:
          removeDeleted: requestBody.removeDeleted
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/de/listVcs'].post
  update:
    x-apievangelist-phrasing:
      intent: List virtual clusters in a CDE service
      effect: read
      questions:
      - What virtual clusters exist on a given Data Engineering service?
      - Can I see every VC under one CDE service?
      instructions:
      - text: List virtual clusters in CDE service {clusterId}.
        slots:
          clusterId: requestBody.clusterId
      - text: Show all VCs running on service {clusterId}.
        slots:
          clusterId: requestBody.clusterId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/de/suspendVc'].post
  update:
    x-apievangelist-phrasing:
      intent: Suspend a virtual cluster
      effect: write
      questions:
      - Can I pause a CDE virtual cluster to save cost?
      - How do I suspend a virtual cluster without deleting it?
      instructions:
      - text: Suspend virtual cluster {vcId} on service {clusterId}.
        slots:
          vcId: requestBody.vcId
          clusterId: requestBody.clusterId
      - text: Pause VC {vcId} in CDE service {clusterId}.
        slots:
          vcId: requestBody.vcId
          clusterId: requestBody.clusterId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/de/resumeVc'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume a suspended virtual cluster
      effect: write
      questions:
      - How do I bring a suspended CDE virtual cluster back online?
      - Can I restart a paused virtual cluster?
      instructions:
      - text: Resume virtual cluster {vcId} on service {clusterId}.
        slots:
          vcId: requestBody.vcId
          clusterId: requestBody.clusterId
      - text: Wake up suspended VC {vcId} in CDE service {clusterId}.
        slots:
          vcId: requestBody.vcId
          clusterId: requestBody.clusterId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/de/getSuspendResumeStatus'].post
  update:
    x-apievangelist-phrasing:
      intent: Check suspend or resume progress
      effect: read
      questions:
      - Has my virtual cluster finished suspending or resuming?
      - What's the next step in a CDE suspend/resume process?
      instructions:
      - text: Get the suspend/resume status of CDE service {clusterId}.
        slots:
          clusterId: requestBody.clusterId
      - text: Check suspend/resume progress for VC {vcId} on service {clusterId}.
        slots:
          vcId: requestBody.vcId
          clusterId: requestBody.clusterId
      method: generated
      generated: '2026-10-01'