API Evangelist conversational phrasing for Cloudera Replication Manager Service Replicationmanager 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 Replication Manager Service Replicationmanager API
  version: 1.0.0
extends: openapi/cloudera-replicationmanager-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/replicationmanager/listClusters'].post
  update:
    x-apievangelist-phrasing:
      intent: List clusters available for replication
      effect: read
      questions:
      - Which clusters can Replication Manager see in my CDP account?
      - What clusters are available to use as replication sources or targets?
      instructions:
      - text: List all the clusters Replication Manager knows about.
      - text: Show me every available replication cluster with its details.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/replicationmanager/listClusterServiceStatuses'].post
  update:
    x-apievangelist-phrasing:
      intent: Show the status of cluster services
      effect: read
      questions:
      - Are HDFS, Hive and YARN healthy on my replication clusters?
      - What state are the services on each cluster in right now?
      instructions:
      - text: List the service statuses across my clusters.
      - text: Show whether HDFS, Hive and YARN are up on each cluster.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/replicationmanager/listAllCredentials'].post
  update:
    x-apievangelist-phrasing:
      intent: List cloud credentials across all clusters
      effect: read
      questions:
      - What cloud credentials are registered across all my replication clusters?
      - Can I see every cloud storage credential Replication Manager has in one list?
      instructions:
      - text: List cloud credentials on every cluster.
      - text: Show all replication cloud credentials account-wide.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/replicationmanager/getCredentials'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the cloud credentials on one cluster
      effect: read
      questions:
      - Which cloud credentials are configured on a specific cluster?
      - Can I look up one credential on a cluster by its name or ID?
      instructions:
      - text: Get the cloud credentials on cluster {clusterCrn}.
        slots:
          clusterCrn: requestBody.clusterCrn
      - text: Look up credential {credentialName} on cluster {clusterCrn}.
        slots:
          credentialName: requestBody.credentialName
          clusterCrn: requestBody.clusterCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/replicationmanager/createAwsCredential'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an AWS cloud credential for replication
      effect: write
      questions:
      - How do I add AWS access keys so replication policies can write to S3?
      - Can one AWS credential be attached to several clusters at once?
      instructions:
      - text: Create an AWS credential named {name} of type {type} on clusters {clusters}.
        slots:
          name: requestBody.name
          type: requestBody.type
          clusters: requestBody.clusters
      - text: Register AWS credential {name} with access key {accessKey} and secret {secretKey} for clusters {clusters}, type {type}.
        slots:
          name: requestBody.name
          accessKey: requestBody.accessKey
          secretKey: requestBody.secretKey
          clusters: requestBody.clusters
          type: requestBody.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/replicationmanager/createAbfsCredential'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an Azure ABFS cloud credential
      effect: write
      questions:
      - How do I set up an ABFS credential so replication can reach Azure Data Lake storage?
      - Can an ABFS credential use a service principal with client ID, secret and tenant?
      instructions:
      - text: Create an ABFS credential {name} of type {type} for storage account {storageAccountName} on clusters {clusters}.
        slots:
          name: requestBody.name
          type: requestBody.type
          storageAccountName: requestBody.storageAccountName
          clusters: requestBody.clusters
      - text: Add ABFS credential {name} ({type}) on {clusters} using client {clientId} in tenant {tenantId}.
        slots:
          name: requestBody.name
          type: requestBody.type
          clusters: requestBody.clusters
          clientId: requestBody.clientId
          tenantId: requestBody.tenantId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/replicationmanager/deleteCredential'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a replication cloud credential
      effect: destructive
      questions:
      - How do I permanently remove a cloud credential from Replication Manager?
      - Can a deleted replication credential be recovered?
      instructions:
      - text: Delete cloud credential {name}.
        slots:
          name: requestBody.name
      - text: Permanently remove the replication credential called {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/replicationmanager/getClusterConfig'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a cluster's configuration
      effect: read
      questions:
      - How is a particular replication cluster configured?
      - Where can I see the configuration details for one cluster?
      instructions:
      - text: Get the configuration of cluster {clusterCrn}.
        slots:
          clusterCrn: requestBody.clusterCrn
      - text: Show me how cluster {clusterCrn} is set up.
        slots:
          clusterCrn: requestBody.clusterCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/replicationmanager/listPolicies'].post
  update:
    x-apievangelist-phrasing:
      intent: List all replication policies
      effect: read
      questions:
      - What replication policies are defined across all my clusters?
      - Which data replication jobs do I have configured today?
      instructions:
      - text: List every replication policy.
      - text: Show all replication policies across clusters.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/replicationmanager/deletePolicy'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a replication policy
      effect: destructive
      questions:
      - How do I permanently delete a Hive or HDFS replication policy by name?
      - Is deleting a replication policy reversible?
      instructions:
      - text: Delete replication policy {policyName} on cluster {clusterCrn}.
        slots:
          policyName: requestBody.policyName
          clusterCrn: requestBody.clusterCrn
      - text: Remove policy {policyName} from {clusterCrn} for good.
        slots:
          policyName: requestBody.policyName
          clusterCrn: requestBody.clusterCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/replicationmanager/createPolicy'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a replication policy
      effect: write
      questions:
      - How do I create a new HDFS or Hive replication policy on a cluster?
      - What goes into a replication policy definition?
      instructions:
      - text: Create replication policy {policyName} on cluster {clusterCrn} with definition {policyDefinition}.
        slots:
          policyName: requestBody.policyName
          clusterCrn: requestBody.clusterCrn
          policyDefinition: requestBody.policyDefinition
      - text: Set up a new replication job called {policyName} on {clusterCrn} using {policyDefinition}.
        slots:
          policyName: requestBody.policyName
          clusterCrn: requestBody.clusterCrn
          policyDefinition: requestBody.policyDefinition
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/replicationmanager/suspendPolicy'].post
  update:
    x-apievangelist-phrasing:
      intent: Suspend a replication policy
      effect: write
      questions:
      - How do I pause all replication tasks for a policy without deleting it?
      - Can I temporarily stop a replication policy by name?
      instructions:
      - text: Suspend replication policy {policyName} on cluster {clusterCrn}.
        slots:
          policyName: requestBody.policyName
          clusterCrn: requestBody.clusterCrn
      - text: Pause the replication tasks of {policyName} on {clusterCrn}.
        slots:
          policyName: requestBody.policyName
          clusterCrn: requestBody.clusterCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/replicationmanager/activatePolicy'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume a suspended replication policy
      effect: write
      questions:
      - How do I restart replication for a policy I suspended earlier?
      - Can I reactivate a paused non-HBase replication policy by name?
      instructions:
      - text: Activate replication policy {policyName} on cluster {clusterCrn}.
        slots:
          policyName: requestBody.policyName
          clusterCrn: requestBody.clusterCrn
      - text: Resume the suspended tasks for {policyName} on {clusterCrn}.
        slots:
          policyName: requestBody.policyName
          clusterCrn: requestBody.clusterCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/replicationmanager/createHbasePolicy'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an HBase replication policy
      effect: write
      questions:
      - How do I replicate HBase tables to another cluster?
      - What do I need before creating an HBase replication policy?
      instructions:
      - text: Set up HBase table replication from cluster {clusterCrn} as policy {policyName} defined by {policyDefinition}.
        slots:
          policyName: requestBody.policyName
          clusterCrn: requestBody.clusterCrn
          policyDefinition: requestBody.policyDefinition
      - text: Start replicating HBase via a new policy {policyName} on {clusterCrn} using {policyDefinition}.
        slots:
          policyName: requestBody.policyName
          clusterCrn: requestBody.clusterCrn
          policyDefinition: requestBody.policyDefinition
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/replicationmanager/updateHbasePolicy'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an HBase replication policy
      effect: write
      questions:
      - Can I change the settings of an existing HBase replication policy?
      - How do I modify an HBase policy without recreating it?
      instructions:
      - text: Update HBase policy {policyId} on cluster {clusterCrn} with {updateHbasePolicyDefinition}.
        slots:
          policyId: requestBody.policyId
          clusterCrn: requestBody.clusterCrn
          updateHbasePolicyDefinition: requestBody.updateHbasePolicyDefinition
      - text: Apply changes {updateHbasePolicyDefinition} to the HBase replication policy {policyId} on {clusterCrn}.
        slots:
          updateHbasePolicyDefinition: requestBody.updateHbasePolicyDefinition
          policyId: requestBody.policyId
          clusterCrn: requestBody.clusterCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/replicationmanager/continueHbaseSetup'].post
  update:
    x-apievangelist-phrasing:
      intent: Continue HBase policy setup after a manual restart
      effect: write
      questions:
      - My HBase policy has a Classic Cluster source; how do I finish its setup after restarting HBase?
      - What do I run once I've manually restarted the source HBase service?
      instructions:
      - text: Continue the setup of HBase policy {policyId} on cluster {clusterCrn}.
        slots:
          policyId: requestBody.policyId
          clusterCrn: requestBody.clusterCrn
      - text: I restarted the source HBase, so resume setup for policy {policyId} on {clusterCrn}.
        slots:
          policyId: requestBody.policyId
          clusterCrn: requestBody.clusterCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/replicationmanager/suspendHbasePolicy'].post
  update:
    x-apievangelist-phrasing:
      intent: Suspend an HBase replication policy
      effect: write
      questions:
      - How do I pause an active HBase replication policy?
      - Does suspending one HBase policy also pause others between the same clusters?
      instructions:
      - text: Suspend HBase policy {policyId} on cluster {clusterCrn}.
        slots:
          policyId: requestBody.policyId
          clusterCrn: requestBody.clusterCrn
      - text: Pause HBase replication for policy {policyId} on {clusterCrn}.
        slots:
          policyId: requestBody.policyId
          clusterCrn: requestBody.clusterCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/replicationmanager/activateHbasePolicy'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume a suspended HBase replication policy
      effect: write
      questions:
      - How do I turn HBase replication back on after suspending it?
      - Will resuming one HBase policy resume every policy between that source and destination?
      instructions:
      - text: Activate HBase policy {policyId} on cluster {clusterCrn}.
        slots:
          policyId: requestBody.policyId
          clusterCrn: requestBody.clusterCrn
      - text: Resume the paused HBase replication policy {policyId} on {clusterCrn}.
        slots:
          policyId: requestBody.policyId
          clusterCrn: requestBody.clusterCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/replicationmanager/deleteHbasePolicy'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete an HBase replication policy
      effect: destructive
      questions:
      - How do I permanently delete an HBase replication policy?
      - Can I force-delete an HBase policy that won't remove cleanly?
      instructions:
      - text: Delete HBase policy {policyId} on cluster {clusterCrn}.
        slots:
          policyId: requestBody.policyId
          clusterCrn: requestBody.clusterCrn
      - text: Force-delete HBase replication policy {policyId} from {clusterCrn} with force set to {force}.
        slots:
          policyId: requestBody.policyId
          clusterCrn: requestBody.clusterCrn
          force: requestBody.force
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/replicationmanager/listPairedHbaseClusters'].post
  update:
    x-apievangelist-phrasing:
      intent: List clusters with an active HBase policy
      effect: read
      questions:
      - Which clusters currently have an active HBase replication policy?
      - What cluster CRNs are already paired for HBase replication?
      instructions:
      - text: List the clusters that have active HBase policies.
      - text: Show me the cluster CRNs paired for HBase replication.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/replicationmanager/verifyHbaseClusterPair'].post
  update:
    x-apievangelist-phrasing:
      intent: Check a cluster pair is ready for HBase replication
      effect: read
      questions:
      - Is my source and destination cluster pair ready for an HBase replication policy?
      - What manual steps are needed before I can create an HBase policy between two clusters?
      instructions:
      - text: Verify HBase readiness from {sourceClusterCrn} to {destinationClusterCrn}.
        slots:
          sourceClusterCrn: requestBody.sourceClusterCrn
          destinationClusterCrn: requestBody.destinationClusterCrn
      - text: Check whether {sourceClusterCrn} and {destinationClusterCrn} can be paired for HBase replication.
        slots:
          sourceClusterCrn: requestBody.sourceClusterCrn
          destinationClusterCrn: requestBody.destinationClusterCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/replicationmanager/downloadDiagnosticBundle'].post
  update:
    x-apievangelist-phrasing:
      intent: Download a collected policy diagnostic bundle
      effect: read
      questions:
      - How do I download the diagnostic bundle I collected for a replication policy?
      - When is a replication diagnostic bundle ready to download?
      instructions:
      - text: Download the diagnostic bundle from command {commandId} on cluster {clusterCrn}.
        slots:
          commandId: requestBody.commandId
          clusterCrn: requestBody.clusterCrn
      - text: Fetch the finished diagnostics for command {commandId} on {clusterCrn}.
        slots:
          commandId: requestBody.commandId
          clusterCrn: requestBody.clusterCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/replicationmanager/collectDiagnosticBundle'].post
  update:
    x-apievangelist-phrasing:
      intent: Collect a diagnostic bundle for a policy
      effect: write
      questions:
      - How do I gather diagnostics to troubleshoot a failing replication policy?
      - Can I trigger diagnostic collection for one policy by name?
      instructions:
      - text: Collect a diagnostic bundle for policy {policyName} on cluster {clusterCrn}.
        slots:
          policyName: requestBody.policyName
          clusterCrn: requestBody.clusterCrn
      - text: Start gathering troubleshooting data for replication policy {policyName} on {clusterCrn}.
        slots:
          policyName: requestBody.policyName
          clusterCrn: requestBody.clusterCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/replicationmanager/getCommandStatus'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the status of a Cloudera Manager command
      effect: read
      questions:
      - What's the status of a Cloudera Manager command running on my cluster?
      - Has my diagnostic bundle command reached DOWNLOADABLE_WITH_CLI yet?
      instructions:
      - text: Get the status of command {commandId} on cluster {clusterCrn}.
        slots:
          commandId: requestBody.commandId
          clusterCrn: requestBody.clusterCrn
      - text: Poll CM command {commandId} on {clusterCrn} and tell me where it is.
        slots:
          commandId: requestBody.commandId
          clusterCrn: requestBody.clusterCrn
      method: generated
      generated: '2026-10-01'