Cloudera · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cloudera Data Warehouse [EXPERIMENTAL] Dw API

96 actions 96 updates phrasing extends openapi/cloudera-dw-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Cloudera's API. It is a proposal applied on top of the contract, not a document Cloudera publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 96 · first 16 shown; the file carries all of them

$.info
$.paths['/api/v1/dw/listClusters'].post
$.paths['/api/v1/dw/describeCluster'].post
$.paths['/api/v1/dw/createClusterDiagnosticDataJob'].post
$.paths['/api/v1/dw/listClusterDiagnosticDataJobs'].post
$.paths['/api/v1/dw/describeClusterDiagnosticDataJob'].post
$.paths['/api/v1/dw/deleteClusterDiagnosticDataJob'].post
$.paths['/api/v1/dw/describeKubeconfig'].post
$.paths['/api/v1/dw/describeAllowedInstanceTypes'].post
$.paths['/api/v1/dw/describeServerSetting'].post
$.paths['/api/v1/dw/updateServerSetting'].post
$.paths['/api/v1/dw/resetServerSettings'].post
$.paths['/api/v1/dw/listEvents'].post
$.paths['/api/v1/dw/updateSshKey'].post
$.paths['/api/v1/dw/renewCertificates'].post
$.paths['/api/v1/dw/createCluster'].post

OpenAPI Overlay

Raw ↑
# 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 Warehouse [EXPERIMENTAL] Dw API
  version: 1.0.0
extends: openapi/cloudera-dw-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: 95
- target: $.paths['/api/v1/dw/listClusters'].post
  update:
    x-apievangelist-phrasing:
      intent: List Data Warehouse clusters
      effect: read
      questions:
      - Which Cloudera Data Warehouse clusters are running in my environments?
      - Can I filter my CDW clusters by status or cloud platform?
      instructions:
      - text: List my Data Warehouse clusters.
      - text: Show CDW clusters in environment {environmentCrn} with status {status}.
        slots:
          environmentCrn: requestBody.environmentCrn
          status: requestBody.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/describeCluster'].post
  update:
    x-apievangelist-phrasing:
      intent: Get details of one Data Warehouse cluster
      effect: read
      questions:
      - What are the settings and state of a specific CDW cluster?
      - Is my Data Warehouse cluster up and which environment is it in?
      instructions:
      - text: Describe Data Warehouse cluster {clusterId}.
        slots:
          clusterId: requestBody.clusterId
      - text: Show me the full details of CDW cluster {clusterId}.
        slots:
          clusterId: requestBody.clusterId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/createClusterDiagnosticDataJob'].post
  update:
    x-apievangelist-phrasing:
      intent: Collect cluster-level diagnostic logs and metrics
      effect: write
      questions:
      - How do I gather logs and metrics from a whole CDW cluster for a support case?
      - Can a cluster diagnostic bundle be limited to a time window and tagged with a case number?
      instructions:
      - text: Start a cluster diagnostic job for {clusterId} sending the bundle to {destination}.
        slots:
          clusterId: requestBody.clusterId
          destination: requestBody.destination
      - text: Collect cluster {clusterId} diagnostics from {startTime} to {endTime} for support case {caseNumber}, uploading to {destination}.
        slots:
          clusterId: requestBody.clusterId
          startTime: requestBody.startTime
          endTime: requestBody.endTime
          caseNumber: requestBody.caseNumber
          destination: requestBody.destination
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/listClusterDiagnosticDataJobs'].post
  update:
    x-apievangelist-phrasing:
      intent: List diagnostic jobs for a cluster
      effect: read
      questions:
      - What cluster-level diagnostic bundles have been collected for my CDW cluster?
      - Can I see only the cluster diagnostic jobs that are still running?
      instructions:
      - text: List the cluster-level diagnostic jobs for {clusterId}.
        slots:
          clusterId: requestBody.clusterId
      - text: Show cluster {clusterId} diagnostic jobs with status {status}.
        slots:
          clusterId: requestBody.clusterId
          status: requestBody.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/describeClusterDiagnosticDataJob'].post
  update:
    x-apievangelist-phrasing:
      intent: Get one cluster diagnostic job
      effect: read
      questions:
      - Has the cluster diagnostic bundle I requested finished?
      - What metadata does a single cluster-level diagnostic job carry?
      instructions:
      - text: Describe cluster diagnostic job {jobId} on cluster {clusterId}.
        slots:
          jobId: requestBody.jobId
          clusterId: requestBody.clusterId
      - text: Check the progress of cluster-wide diagnostics job {jobId} for {clusterId}.
        slots:
          jobId: requestBody.jobId
          clusterId: requestBody.clusterId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/deleteClusterDiagnosticDataJob'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a cluster diagnostic job
      effect: destructive
      questions:
      - Can I delete a cluster-level diagnostic job even while it's still running?
      - How do I remove an old cluster diagnostic bundle job?
      instructions:
      - text: Delete cluster diagnostic job {jobId} on cluster {clusterId}.
        slots:
          jobId: requestBody.jobId
          clusterId: requestBody.clusterId
      - text: Cancel and remove the cluster-wide diagnostics job {jobId} from {clusterId}.
        slots:
          jobId: requestBody.jobId
          clusterId: requestBody.clusterId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/describeKubeconfig'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the kubeconfig for a cluster
      effect: read
      questions:
      - How can I get kubectl access to the Kubernetes behind my CDW cluster?
      - Where do I download the kubeconfig file for a Data Warehouse cluster?
      instructions:
      - text: Get the kubeconfig for cluster {clusterId}.
        slots:
          clusterId: requestBody.clusterId
      - text: Give me a kubeconfig so I can run kubectl against {clusterId}.
        slots:
          clusterId: requestBody.clusterId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/describeAllowedInstanceTypes'].post
  update:
    x-apievangelist-phrasing:
      intent: List allowed compute instance types
      effect: read
      questions:
      - Which compute instance types can a CDW cluster use on AWS and Azure?
      - What's the default instance type for Data Warehouse compute?
      instructions:
      - text: List the allowed instance types for Data Warehouse clusters.
      - text: Show the default and permitted compute node sizes for AWS and Azure.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/describeServerSetting'].post
  update:
    x-apievangelist-phrasing:
      intent: Show the DWX server settings
      effect: read
      questions:
      - What server settings are currently enabled in my DWX Private Cloud?
      - Which Data Warehouse server feature toggles are on right now?
      instructions:
      - text: Show the current DWX server settings.
      - text: List which DWX server toggles are switched on.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/updateServerSetting'].post
  update:
    x-apievangelist-phrasing:
      intent: Turn DWX server settings on or off
      effect: write
      questions:
      - How do I enable or disable a DWX server setting?
      - Do some server setting changes require recreating a Virtual Warehouse?
      instructions:
      - text: Update the DWX server settings to {settings}.
        slots:
          settings: requestBody.settings
      - text: 'Switch these DWX server toggles: {settings}.'
        slots:
          settings: requestBody.settings
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/resetServerSettings'].post
  update:
    x-apievangelist-phrasing:
      intent: Reset DWX server settings to defaults
      effect: destructive
      questions:
      - Can I put all DWX server settings back to their default values?
      - What happens to my custom server toggles if I reset them?
      instructions:
      - text: Reset the DWX server settings to their defaults.
      - text: Undo all my DWX server setting changes and restore the factory values.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/listEvents'].post
  update:
    x-apievangelist-phrasing:
      intent: List events for an operation or service
      effect: read
      questions:
      - What events happened during a particular Data Warehouse operation?
      - Can I see the event history for a Data Visualization app or cluster by its service ID?
      instructions:
      - text: List events for operation {operationId}.
        slots:
          operationId: requestBody.operationId
      - text: Show the last {limit} events for service {serviceId}, oldest first set to {ascending}.
        slots:
          limit: requestBody.limit
          serviceId: requestBody.serviceId
          ascending: requestBody.ascending
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/updateSshKey'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a cluster's SSH key
      effect: write
      questions:
      - How do I rotate the SSH key on a CDW cluster?
      - Can I change the SSH key for a Data Warehouse cluster after it's created?
      instructions:
      - text: Update the SSH key for cluster {clusterId}.
        slots:
          clusterId: requestBody.clusterId
      - text: Rotate the SSH key on Data Warehouse cluster {clusterId}.
        slots:
          clusterId: requestBody.clusterId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/renewCertificates'].post
  update:
    x-apievangelist-phrasing:
      intent: Renew certificates on a public cloud cluster
      effect: write
      questions:
      - My CDW public cloud cluster certificates are expiring; how do I renew them?
      - Can I refresh TLS certificates on a Data Warehouse cluster?
      instructions:
      - text: Renew the certificates on cluster {clusterId}.
        slots:
          clusterId: requestBody.clusterId
      - text: Refresh expiring certs for public cloud CDW cluster {clusterId}.
        slots:
          clusterId: requestBody.clusterId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/createCluster'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate a Data Warehouse cluster (generic)
      effect: write
      questions:
      - How do I activate Cloudera Data Warehouse on an environment with one generic call?
      - Can I restrict cluster access to certain IP ranges when activating Data Warehouse?
      instructions:
      - text: Create a Data Warehouse cluster in environment {environmentCrn}.
        slots:
          environmentCrn: requestBody.environmentCrn
      - text: Activate CDW on {environmentCrn} with a private load balancer set to {usePrivateLoadBalancer} and allowed CIDRs {whitelistIpCIDRs}.
        slots:
          environmentCrn: requestBody.environmentCrn
          usePrivateLoadBalancer: requestBody.usePrivateLoadBalancer
          whitelistIpCIDRs: requestBody.whitelistIpCIDRs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/createAwsCluster'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an AWS Data Warehouse cluster
      effect: write
      questions:
      - What does it take to stand up a CDW cluster on AWS with private EKS?
      - Can my AWS Data Warehouse cluster use spot instances or a custom AMI?
      instructions:
      - text: Create an AWS Data Warehouse cluster in environment {environmentCrn}.
        slots:
          environmentCrn: requestBody.environmentCrn
      - text: Spin up an AWS CDW cluster in {environmentCrn} on worker subnets {workerSubnetIds} with spot instances {enableSpotInstances}.
        slots:
          environmentCrn: requestBody.environmentCrn
          workerSubnetIds: requestBody.workerSubnetIds
          enableSpotInstances: requestBody.enableSpotInstances
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/createAzureCluster'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an Azure Data Warehouse cluster
      effect: write
      questions:
      - What do I need to create a CDW cluster on Azure, like a managed identity and subnet?
      - Can an Azure Data Warehouse cluster run on a private AKS cluster?
      instructions:
      - text: Create an Azure Data Warehouse cluster in {environmentCrn} using identity {userAssignedManagedIdentity} on subnet {subnetName}.
        slots:
          environmentCrn: requestBody.environmentCrn
          userAssignedManagedIdentity: requestBody.userAssignedManagedIdentity
          subnetName: requestBody.subnetName
      - text: Spin up an AKS-backed CDW cluster in {environmentCrn} on subnet {subnetName} with identity {userAssignedManagedIdentity} and private AKS {enablePrivateAks}.
        slots:
          environmentCrn: requestBody.environmentCrn
          subnetName: requestBody.subnetName
          userAssignedManagedIdentity: requestBody.userAssignedManagedIdentity
          enablePrivateAks: requestBody.enablePrivateAks
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/createPrivateCluster'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Private Cloud Data Warehouse cluster
      effect: write
      questions:
      - How do I activate Data Warehouse on a Private Cloud environment?
      - Can I pick a storage class or dedicated executor nodes for a Private Cloud CDW cluster?
      instructions:
      - text: Create a Private Cloud Data Warehouse cluster in {environmentCrn}.
        slots:
          environmentCrn: requestBody.environmentCrn
      - text: Activate on-prem CDW in {environmentCrn} using storage class {storageClass}.
        slots:
          environmentCrn: requestBody.environmentCrn
          storageClass: requestBody.storageClass
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/deleteCluster'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a Data Warehouse cluster
      effect: destructive
      questions:
      - How do I tear down a whole Cloudera Data Warehouse cluster?
      - Can I force-delete a CDW cluster that's stuck?
      instructions:
      - text: Delete Data Warehouse cluster {clusterId}.
        slots:
          clusterId: requestBody.clusterId
      - text: Force the deletion of CDW cluster {clusterId} with force {force}.
        slots:
          clusterId: requestBody.clusterId
          force: requestBody.force
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/updateCluster'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a Data Warehouse cluster's settings
      effect: write
      questions:
      - Can I change the allowed IP ranges on an existing CDW cluster?
      - Where do I update a cluster's description or observability config?
      instructions:
      - text: Update cluster {clusterId} to allow CIDRs {whitelistIpCIDRs}.
        slots:
          clusterId: requestBody.clusterId
          whitelistIpCIDRs: requestBody.whitelistIpCIDRs
      - text: Change the description of Data Warehouse cluster {clusterId} to {description}.
        slots:
          clusterId: requestBody.clusterId
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/backupCluster'].post
  update:
    x-apievangelist-phrasing:
      intent: Export a cluster's configuration as backup data
      effect: read
      questions:
      - How do I export a cluster's configuration, including its Virtual Warehouses and Data Viz apps?
      - Can I capture CDW cluster settings so I can restore them later?
      instructions:
      - text: Back up the configuration of cluster {clusterId}.
        slots:
          clusterId: requestBody.clusterId
      - text: Export the settings of {clusterId} and its catalogs and warehouses as backup data.
        slots:
          clusterId: requestBody.clusterId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/restoreCluster'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore a cluster from exported configuration
      effect: write
      questions:
      - How do I recreate my Virtual Warehouses and Data Viz apps from a cluster configuration export?
      - What does restoring a cluster from backup-cluster data bring back?
      instructions:
      - text: Restore cluster {clusterId} from backup data {data}.
        slots:
          clusterId: requestBody.clusterId
          data: requestBody.data
      - text: Rebuild the warehouses and catalog config on {clusterId} using the exported settings {data}.
        slots:
          clusterId: requestBody.clusterId
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/createDataVisualization'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Data Visualization app
      effect: write
      questions:
      - How do I add a Cloudera Data Visualization app to my warehouse cluster?
      - Can I choose an image version or resource template for a new Data Viz app?
      instructions:
      - text: Create a Data Visualization app named {name} on cluster {clusterId} with config {config}.
        slots:
          name: requestBody.name
          clusterId: requestBody.clusterId
          config: requestBody.config
      - text: Deploy Data Viz {name} on {clusterId} using config {config} and image {imageVersion}.
        slots:
          name: requestBody.name
          clusterId: requestBody.clusterId
          config: requestBody.config
          imageVersion: requestBody.imageVersion
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/listDataVisualizations'].post
  update:
    x-apievangelist-phrasing:
      intent: List Data Visualization apps in a cluster
      effect: read
      questions:
      - Which Data Visualization apps are running on my CDW cluster?
      - What dashboards apps exist in a given warehouse cluster?
      instructions:
      - text: List the Data Visualization apps on cluster {clusterId}.
        slots:
          clusterId: requestBody.clusterId
      - text: Show all Data Viz instances in {clusterId}.
        slots:
          clusterId: requestBody.clusterId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/deleteDataVisualization'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a Data Visualization app
      effect: destructive
      questions:
      - How do I remove a Data Visualization app from a cluster?
      - Can I still check a Data Viz app's status while it's being deleted?
      instructions:
      - text: Delete Data Visualization {dataVisualizationId} on cluster {clusterId}.
        slots:
          dataVisualizationId: requestBody.dataVisualizationId
          clusterId: requestBody.clusterId
      - text: Tear down the Data Viz app {dataVisualizationId} in {clusterId}.
        slots:
          dataVisualizationId: requestBody.dataVisualizationId
          clusterId: requestBody.clusterId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/describeDataVisualization'].post
  update:
    x-apievangelist-phrasing:
      intent: Get details and status of a Data Visualization app
      effect: read
      questions:
      - What state is my Data Visualization app in after an update or upgrade?
      - Which config and version is a specific Data Viz app running?
      instructions:
      - text: Describe Data Visualization {dataVisualizationId} on cluster {clusterId}.
        slots:
          dataVisualizationId: requestBody.dataVisualizationId
          clusterId: requestBody.clusterId
      - text: Check the current status of Data Viz app {dataVisualizationId} in {clusterId}.
        slots:
          dataVisualizationId: requestBody.dataVisualizationId
          clusterId: requestBody.clusterId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/updateDataVisualization'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a Data Visualization app's configuration
      effect: write
      questions:
      - Can I reconfigure a running Data Visualization app?
      - Is changing a Data Viz app's settings asynchronous?
      instructions:
      - text: Update Data Visualization {dataVisualizationId} on {clusterId} with config {config}.
        slots:
          dataVisualizationId: requestBody.dataVisualizationId
          clusterId: requestBody.clusterId
          config: requestBody.config
      - text: Apply new settings {config} to Data Viz app {dataVisualizationId} in cluster {clusterId}.
        slots:
          config: requestBody.config
          dataVisualizationId: requestBody.dataVisualizationId
          clusterId: requestBody.clusterId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/getDataVisualizationUpgradeVersion'].post
  update:
    x-apievangelist-phrasing:
      intent: Check upgrade versions for a Data Visualization app
      effect: read
      questions:
      - Is there a newer compatible version for my Data Visualization app?
      - What's the latest Data Viz version I could upgrade to?
      instructions:
      - text: Get the upgrade versions for Data Visualization {dataVisualizationId} on {clusterId}.
        slots:
          dataVisualizationId: requestBody.dataVisualizationId
          clusterId: requestBody.clusterId
      - text: Tell me the latest compatible Data Viz release for app {dataVisualizationId} in {clusterId}.
        slots:
          dataVisualizationId: requestBody.dataVisualizationId
          clusterId: requestBody.clusterId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/upgradeDataVisualization'].post
  update:
    x-apievangelist-phrasing:
      intent: Upgrade a Data Visualization app
      effect: write
      questions:
      - How do I move a Data Visualization app to a newer image version?
      - Can I change the resource pool while upgrading a Data Viz app?
      instructions:
      - text: Upgrade Data Visualization {dataVisualizationId} on {clusterId} to version {imageVersion}.
        slots:
          dataVisualizationId: requestBody.dataVisualizationId
          clusterId: requestBody.clusterId
          imageVersion: requestBody.imageVersion
      - text: Move Data Viz app {dataVisualizationId} in {clusterId} to image {imageVersion} in resource pool {resourcePool}.
        slots:
          dataVisualizationId: requestBody.dataVisualizationId
          clusterId: requestBody.clusterId
          imageVersion: requestBody.imageVersion
          resourcePool: requestBody.resourcePool
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/registerSecret'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a cloud vault secret reference
      effect: write
      questions:
      - How do I point CDW at a secret already stored in my cloud provider's vault?
      - Can I reference an Azure Key Vault secret for an external data source connection?
      instructions:
      - text: Register vault secret {secretName} for cluster {clusterId}.
        slots:
          secretName: requestBody.secretName
          clusterId: requestBody.clusterId
      - text: Reference secret {secretName} from Azure vault {azureVaultName} on cluster {clusterId}.
        slots:
          secretName: requestBody.secretName
          azureVaultName: requestBody.azureVaultName
          clusterId: requestBody.clusterId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/createSecret'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a secret in the cluster's Kubernetes
      effect: write
      questions:
      - How do I store a password for an external data source directly in my CDW Kubernetes cluster?
      - Can I create a new Kubernetes secret value through the Data Warehouse API?
      instructions:
      - text: Create a Kubernetes secret {secretName} on cluster {clusterId} with value {secretValue}.
        slots:
          secretName: requestBody.secretName
          clusterId: requestBody.clusterId
          secretValue: requestBody.secretValue
      - text: Store the credential {secretValue} as k8s secret {secretName} in {clusterId}.
        slots:
          secretValue: requestBody.secretValue
          secretName: requestBody.secretName
          clusterId: requestBody.clusterId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/listSecrets'].post
  update:
    x-apievangelist-phrasing:
      intent: List secrets for a cluster
      effect: read
      questions:
      - Which secrets are registered for external data sources on my cluster?
      - What cloud provider secrets has CDW recorded in this environment?
      instructions:
      - text: List the secrets on cluster {clusterId}.
        slots:
          clusterId: requestBody.clusterId
      - text: Show every stored secret name for {clusterId}.
        slots:
          clusterId: requestBody.clusterId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/deleteSecret'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a stored secret
      effect: destructive
      questions:
      - How do I remove a secret I no longer need for a data source?
      - Can I delete a secret by name from a CDW cluster?
      instructions:
      - text: Delete secret {secretName} from cluster {clusterId}.
        slots:
          secretName: requestBody.secretName
          clusterId: requestBody.clusterId
      - text: Remove the {secretName} secret on {clusterId}.
        slots:
          secretName: requestBody.secretName
          clusterId: requestBody.clusterId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/createConnector'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a database connector
      effect: write
      questions:
      - How do I add a Trino connector to an external database in my CDW cluster?
      - What template and config does a new database connector need?
      instructions:
      - text: Create connector {name} from template {template} on cluster {clusterId}.
        slots:
          name: requestBody.name
          template: requestBody.template
          clusterId: requestBody.clusterId
      - text: Add a new database connector {name} using template {template} with config {config}.
        slots:
          name: requestBody.name
          template: requestBody.template
          config: requestBody.config
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/createConnectorTestJob'].post
  update:
    x-apievangelist-phrasing:
      intent: Test a Trino connector
      effect: write
      questions:
      - Can I check that a Trino connector actually reaches its data source before using it?
      - How do I run a connection test for a connector config I haven't saved yet?
      instructions:
      - text: Test connector {connectorId} on cluster {clusterId}.
        slots:
          connectorId: requestBody.connectorId
          clusterId: requestBody.clusterId
      - text: Run a connection test on {clusterId} for connector {connectorName} with config {config}.
        slots:
          clusterId: requestBody.clusterId
          connectorName: requestBody.connectorName
          config: requestBody.config
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/listConnectorTestJobs'].post
  update:
    x-apievangelist-phrasing:
      intent: List connector test jobs
      effect: read
      questions:
      - Did my Trino connector tests pass?
      - Where can I see the results of past connector test runs?
      instructions:
      - text: List connector test jobs on cluster {clusterId}.
        slots:
          clusterId: requestBody.clusterId
      - text: Show the result of connector test {jobId} in {clusterId}.
        slots:
          jobId: requestBody.jobId
          clusterId: requestBody.clusterId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/listConnectors'].post
  update:
    x-apievangelist-phrasing:
      intent: List database connectors in a cluster
      effect: read
      questions:
      - Which database connectors are configured on my CDW cluster?
      - What external sources can my warehouse query through connectors?
      instructions:
      - text: List the database connectors on cluster {clusterId}.
        slots:
          clusterId: requestBody.clusterId
      - text: Show all connectors defined in {clusterId}.
        slots:
          clusterId: requestBody.clusterId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/deleteConnector'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a database connector
      effect: destructive
      questions:
      - How do I remove a database connector from a cluster?
      - Can I delete a connector my warehouses no longer use?
      instructions:
      - text: Delete connector {connectorId} from cluster {clusterId}.
        slots:
          connectorId: requestBody.connectorId
          clusterId: requestBody.clusterId
      - text: Remove database connector {connectorId} in {clusterId}.
        slots:
          connectorId: requestBody.connectorId
          clusterId: requestBody.clusterId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/updateConnector'].post
  update:
    x-apievangelist-phrasing:
      intent: Edit an existing database connector
      effect: write
      questions:
      - Can I rename or change the config of a connector I already created?
      - How do I switch an existing connector to a different template?
      instructions:
      - text: Update connector {connectorId} on {clusterId} with config {config}.
        slots:
          connectorId: requestBody.connectorId
          clusterId: requestBody.clusterId
          config: requestBody.config
      - text: Rename existing connector {connectorId} in {clusterId} to {name}.
        slots:
          connectorId: requestBody.connectorId
          clusterId: requestBody.clusterId
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/createDbc'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Database Catalog (deprecated)
      effect: write
      questions:
      - Can I still create an extra Database Catalog even though it's deprecated?
      - Is it possible to load demo data when making a new Database Catalog?
      instructions:
      - text: Create Database Catalog {name} on cluster {clusterId}.
        slots:
          name: requestBody.name
          clusterId: requestBody.clusterId
      - text: Make a new catalog {name} in {clusterId} with demo data {loadDemoData}.
        slots:
          name: requestBody.name
          clusterId: requestBody.clusterId
          loadDemoData: requestBody.loadDemoData
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/listDbcs'].post
  update:
    x-apievangelist-phrasing:
      intent: List Database Catalogs in a cluster
      effect: read
      questions:
      - Which Database Catalogs exist on my CDW cluster?
      - What's the ID of the default Database Catalog in a cluster?
      instructions:
      - text: List the Database Catalogs on cluster {clusterId}.
        slots:
          clusterId: requestBody.clusterId
      - text: Show every DBC in {clusterId}.
        slots:
          clusterId: requestBody.clusterId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dw/describeDbc'].post
  update:
    x-apievangelist-phrasing:
      intent: Get details of a Database Catalog
      effect: read
      questions:
      - Is my Database Catalog running or suspended?
      - What version and status does a specific DBC report?
      instructions:
      - text: Describe Database Catalog {dbcId} on cluster {clusterId}.
        slots:
          dbcId: requestBody.dbcId
          clusterId: requestBody.clusterId
      - text: Show the status of DBC {dbcId} in {clusterId}.
        slots:
          dbcId: requestBody.dbcId
          clusterId: requestBody.clusterId
      method: generated
      generated: '2026-10-01'


# --- truncated at 32 KB (70 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/overlays/cloudera-dw-api-phrasing-overlay.yaml