Cloudera · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Cloudera Data hub Service Datahub API
76 actions
76 updates
phrasing
extends
openapi/cloudera-data-hub-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.
What the actions change
x-apievangelist-phrasing
Targets 76 · first 16 shown; the file carries all of them
$.info
$.paths['/api/v1/datahub/deleteInstances'].post
$.paths['/api/v1/datahub/listClusters'].post
$.paths['/api/v1/datahub/listScalingActivities'].post
$.paths['/api/v1/datahub/describeScalingActivity'].post
$.paths['/api/v1/datahub/listClusterLifecycleEvents'].post
$.paths['/api/v1/datahub/createAWSCluster'].post
$.paths['/api/v1/datahub/createAWSGovCloudCluster'].post
$.paths['/api/v1/datahub/createAzureCluster'].post
$.paths['/api/v1/datahub/createGCPCluster'].post
$.paths['/api/v1/datahub/deleteCluster'].post
$.paths['/api/v1/datahub/describeCluster'].post
$.paths['/api/v1/datahub/getClusterServiceStatus'].post
$.paths['/api/v1/datahub/getClusterHostStatus'].post
$.paths['/api/v1/datahub/stopCluster'].post
$.paths['/api/v1/datahub/startCluster'].post
OpenAPI Overlay
# 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 hub Service Datahub API
version: 1.0.0
extends: openapi/cloudera-data-hub-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: 75
- target: $.paths['/api/v1/datahub/deleteInstances'].post
update:
x-apievangelist-phrasing:
intent: Delete specific instances from a cluster
effect: destructive
questions:
- Can I remove particular VM instances from a Data Hub cluster by id?
- Is there a way to force-delete instances that won't terminate cleanly?
instructions:
- text: Delete instances {instanceIds} from Data Hub cluster {clusterName}.
slots:
instanceIds: requestBody.instanceIds
clusterName: requestBody.clusterName
- text: Force delete instances {instanceIds} on cluster {clusterName}.
slots:
instanceIds: requestBody.instanceIds
clusterName: requestBody.clusterName
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/listClusters'].post
update:
x-apievangelist-phrasing:
intent: List Data Hub workload clusters
effect: read
questions:
- Which Data Hub clusters do I have?
- Can I list only the workload clusters in one environment?
instructions:
- text: List all my Data Hub workload clusters.
- text: List the Data Hub clusters in environment {environmentName}.
slots:
environmentName: requestBody.environmentName
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/listScalingActivities'].post
update:
x-apievangelist-phrasing:
intent: List scaling activities for a cluster
effect: read
questions:
- What scaling activity has happened on my Data Hub cluster recently?
- Can I see only the failed scaling activities within a time window?
instructions:
- text: List scaling activities for Data Hub cluster {cluster}.
slots:
cluster: requestBody.cluster
- text: List failed scaling activities on {cluster} between {startTime} and {endTime}.
slots:
cluster: requestBody.cluster
startTime: requestBody.startTime
endTime: requestBody.endTime
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/describeScalingActivity'].post
update:
x-apievangelist-phrasing:
intent: Get details of one scaling activity
effect: read
questions:
- What happened during a specific scaling operation on my cluster?
- Can I look up a scaling activity by its operation id?
instructions:
- text: Describe scaling activity {operationId} on cluster {cluster}.
slots:
operationId: requestBody.operationId
cluster: requestBody.cluster
- text: Show details of the scaling operation {operationId} for Data Hub {cluster}.
slots:
operationId: requestBody.operationId
cluster: requestBody.cluster
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/listClusterLifecycleEvents'].post
update:
x-apievangelist-phrasing:
intent: List lifecycle events of a cluster
effect: read
questions:
- What lifecycle events has my Data Hub cluster gone through?
- Can I page through the event history of a workload cluster?
instructions:
- text: List lifecycle events for Data Hub cluster {cluster}.
slots:
cluster: requestBody.cluster
- text: Show the event history of cluster {cluster}, {pageSize} events per page.
slots:
cluster: requestBody.cluster
pageSize: requestBody.pageSize
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/createAWSCluster'].post
update:
x-apievangelist-phrasing:
intent: Create a Data Hub cluster on AWS
effect: write
questions:
- How do I spin up a new Data Hub cluster on AWS?
- Can I enable multi-AZ or a load balancer on an AWS workload cluster?
instructions:
- text: Create AWS Data Hub cluster {clusterName} in environment {environmentName} from definition {clusterDefinitionName}.
slots:
clusterName: requestBody.clusterName
environmentName: requestBody.environmentName
clusterDefinitionName: requestBody.clusterDefinitionName
- text: Create AWS cluster {clusterName} in {environmentName} using template {clusterTemplateName} on {architecture} with Java {javaVersion}.
slots:
clusterName: requestBody.clusterName
environmentName: requestBody.environmentName
clusterTemplateName: requestBody.clusterTemplateName
architecture: requestBody.architecture
javaVersion: requestBody.javaVersion
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/createAWSGovCloudCluster'].post
update:
x-apievangelist-phrasing:
intent: Create a Data Hub cluster on AWS GovCloud
effect: write
questions:
- Can I create a Data Hub cluster in AWS GovCloud?
- What's needed to launch a GovCloud workload cluster with multi-AZ?
instructions:
- text: Create GovCloud Data Hub cluster {clusterName} in environment {environment} from definition {clusterDefinition}.
slots:
clusterName: requestBody.clusterName
environment: requestBody.environment
clusterDefinition: requestBody.clusterDefinition
- text: Launch AWS GovCloud cluster {clusterName} in {environment} with subnets {subnetIds} across multiple AZs.
slots:
clusterName: requestBody.clusterName
environment: requestBody.environment
subnetIds: requestBody.subnetIds
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/createAzureCluster'].post
update:
x-apievangelist-phrasing:
intent: Create a Data Hub cluster on Azure
effect: write
questions:
- How do I create a Data Hub cluster in an Azure environment?
- Can I choose the load balancer SKU or a flexible server database for an Azure cluster?
instructions:
- text: Create Azure Data Hub cluster {clusterName} in environment {environmentName} from definition {clusterDefinitionName}.
slots:
clusterName: requestBody.clusterName
environmentName: requestBody.environmentName
clusterDefinitionName: requestBody.clusterDefinitionName
- text: Create Azure cluster {clusterName} in {environmentName} with load balancer SKU {loadBalancerSku} and database type {databaseType}.
slots:
clusterName: requestBody.clusterName
environmentName: requestBody.environmentName
loadBalancerSku: requestBody.loadBalancerSku
databaseType: requestBody.databaseType
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/createGCPCluster'].post
update:
x-apievangelist-phrasing:
intent: Create a Data Hub cluster on Google Cloud
effect: write
questions:
- Can I launch a Data Hub workload cluster on GCP?
- Which subnet and template settings does a Google Cloud Data Hub cluster take?
instructions:
- text: Create GCP Data Hub cluster {clusterName} in environment {environmentName} from definition {clusterDefinitionName}.
slots:
clusterName: requestBody.clusterName
environmentName: requestBody.environmentName
clusterDefinitionName: requestBody.clusterDefinitionName
- text: Create Google Cloud cluster {clusterName} in {environmentName} on subnet {subnetName} using template {clusterTemplateName}.
slots:
clusterName: requestBody.clusterName
environmentName: requestBody.environmentName
subnetName: requestBody.subnetName
clusterTemplateName: requestBody.clusterTemplateName
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/deleteCluster'].post
update:
x-apievangelist-phrasing:
intent: Delete a Data Hub cluster
effect: destructive
questions:
- How do I tear down a Data Hub cluster I no longer need?
- Can I force-delete a workload cluster that is stuck?
instructions:
- text: Delete Data Hub cluster {clusterName}.
slots:
clusterName: requestBody.clusterName
- text: Force delete the workload cluster {clusterName}.
slots:
clusterName: requestBody.clusterName
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/describeCluster'].post
update:
x-apievangelist-phrasing:
intent: Get details of a Data Hub cluster
effect: read
questions:
- What is the configuration and state of one of my Data Hub clusters?
- Can I look up a workload cluster's details by name?
instructions:
- text: Describe Data Hub cluster {clusterName}.
slots:
clusterName: requestBody.clusterName
- text: Show me the full details of workload cluster {clusterName}.
slots:
clusterName: requestBody.clusterName
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/getClusterServiceStatus'].post
update:
x-apievangelist-phrasing:
intent: Check status of services in a cluster
effect: read
questions:
- Are all the services in my Data Hub cluster running?
- Which cluster services are unhealthy right now?
instructions:
- text: Get the service status for Data Hub cluster {clusterName}.
slots:
clusterName: requestBody.clusterName
- text: Check which services are healthy on cluster {clusterName}.
slots:
clusterName: requestBody.clusterName
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/getClusterHostStatus'].post
update:
x-apievangelist-phrasing:
intent: Check status of hosts in a cluster
effect: read
questions:
- Are any hosts in my Data Hub cluster down?
- What state is each host in a workload cluster in?
instructions:
- text: Get the host status for Data Hub cluster {clusterName}.
slots:
clusterName: requestBody.clusterName
- text: Check the health of every host on cluster {clusterName}.
slots:
clusterName: requestBody.clusterName
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/stopCluster'].post
update:
x-apievangelist-phrasing:
intent: Stop a Data Hub cluster
effect: write
questions:
- Can I stop a Data Hub cluster to give its VMs back to the cloud provider?
- What happens to the VMs when a workload cluster is stopped?
instructions:
- text: Stop Data Hub cluster {clusterName}.
slots:
clusterName: requestBody.clusterName
- text: Shut down workload cluster {clusterName} and release its VMs.
slots:
clusterName: requestBody.clusterName
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/startCluster'].post
update:
x-apievangelist-phrasing:
intent: Start a stopped Data Hub cluster
effect: write
questions:
- How do I bring a stopped Data Hub cluster back up?
- Will starting a stopped cluster provision new VMs?
instructions:
- text: Start the stopped Data Hub cluster {clusterName}.
slots:
clusterName: requestBody.clusterName
- text: Bring workload cluster {clusterName} back online.
slots:
clusterName: requestBody.clusterName
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/retryCluster'].post
update:
x-apievangelist-phrasing:
intent: Retry a failed cluster creation
effect: write
questions:
- My Data Hub cluster creation failed — can I resume from the last failed step?
- Is there a way to retry provisioning without recreating the whole cluster?
instructions:
- text: Retry creation of failed Data Hub cluster {clusterName}.
slots:
clusterName: requestBody.clusterName
- text: Resume provisioning of {clusterName} from the last failed step.
slots:
clusterName: requestBody.clusterName
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/renewCertificate'].post
update:
x-apievangelist-phrasing:
intent: Renew a cluster certificate (deprecated)
effect: write
questions:
- Is the older renew-certificate call for Data Hub still available?
- Which deprecated endpoint renews a cluster certificate by name?
instructions:
- text: Renew the certificate on Data Hub {clusterName} using the deprecated renew-certificate call.
slots:
clusterName: requestBody.clusterName
- text: Use the legacy certificate renewal for cluster {clusterName}.
slots:
clusterName: requestBody.clusterName
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/renewPublicCertificate'].post
update:
x-apievangelist-phrasing:
intent: Renew a Data Hub's public certificate
effect: write
questions:
- How do I renew the public TLS certificate on a Data Hub cluster?
- My Data Hub's public certificate is about to expire — can I renew it?
instructions:
- text: Renew the public certificate on Data Hub {datahub}.
slots:
datahub: requestBody.datahub
- text: Refresh the expiring public certificate for {datahub}.
slots:
datahub: requestBody.datahub
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/repairCluster'].post
update:
x-apievangelist-phrasing:
intent: Repair failed nodes in a cluster
effect: write
questions:
- Can I repair unhealthy nodes in my Data Hub cluster?
- Is it possible to repair just one instance group, or only remove the bad nodes?
instructions:
- text: Repair Data Hub cluster {clusterName}.
slots:
clusterName: requestBody.clusterName
- text: Repair instance groups {instanceGroupNames} on cluster {clusterName}.
slots:
instanceGroupNames: requestBody.instanceGroupNames
clusterName: requestBody.clusterName
- text: Repair instances {instances} on {clusterName} by removing them only.
slots:
instances: requestBody.instances
clusterName: requestBody.clusterName
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/restartClusterInstances'].post
update:
x-apievangelist-phrasing:
intent: Restart cluster instances on the cloud provider
effect: write
questions:
- Can I reboot specific VMs of a Data Hub cluster?
- What's the way to restart instances at the cloud-provider level?
instructions:
- text: Restart instances {instances} of Data Hub cluster {cluster}.
slots:
instances: requestBody.instances
cluster: requestBody.cluster
- text: Reboot VMs {instances} in {cluster} on the cloud provider.
slots:
instances: requestBody.instances
cluster: requestBody.cluster
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/rotateDbCertificate'].post
update:
x-apievangelist-phrasing:
intent: Rotate a Data Hub's database SSL certificate
effect: write
questions:
- How do I rotate the database SSL certificate for a Data Hub?
- Can I refresh the SSL cert used by a Data Hub's database?
instructions:
- text: Rotate the database SSL certificate for Data Hub {datahubName}.
slots:
datahubName: requestBody.datahubName
- text: Refresh the DB SSL cert on {datahubName}.
slots:
datahubName: requestBody.datahubName
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/syncCluster'].post
update:
x-apievangelist-phrasing:
intent: Sync cluster state with cloud and Cloudera Manager
effect: write
questions:
- My cluster state looks out of date — can I resync it with the cloud provider?
- Is there a way to reconcile a Data Hub with Cloudera Manager's view?
instructions:
- text: Sync Data Hub cluster {clusterName} with the cloud provider and Cloudera Manager.
slots:
clusterName: requestBody.clusterName
- text: Reconcile the state of {clusterName}.
slots:
clusterName: requestBody.clusterName
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/scaleCluster'].post
update:
x-apievangelist-phrasing:
intent: Scale nodes in a cluster instance group
effect: write
questions:
- How do I add or remove nodes from a Data Hub instance group?
- Can I prefer certain subnets or zones when scaling out?
instructions:
- text: Scale instance group {instanceGroupName} on cluster {clusterName} to {instanceGroupDesiredCount} nodes.
slots:
instanceGroupName: requestBody.instanceGroupName
clusterName: requestBody.clusterName
instanceGroupDesiredCount: requestBody.instanceGroupDesiredCount
- text: Resize {instanceGroupName} in {clusterName} to {instanceGroupDesiredCount} nodes, preferring zones {preferredZones}.
slots:
instanceGroupName: requestBody.instanceGroupName
clusterName: requestBody.clusterName
instanceGroupDesiredCount: requestBody.instanceGroupDesiredCount
preferredZones: requestBody.preferredZones
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/listRecipes'].post
update:
x-apievangelist-phrasing:
intent: List cluster recipes
effect: read
questions:
- What recipe scripts have been registered for Data Hub clusters?
- Which recipes are available to run on instance groups?
instructions:
- text: List all Data Hub recipes.
- text: Show me the recipe scripts I can attach to instance groups.
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/deleteRecipes'].post
update:
x-apievangelist-phrasing:
intent: Delete recipes
effect: destructive
questions:
- Can I delete several recipes at once?
- How do I remove recipe scripts I no longer use?
instructions:
- text: Delete recipes {recipeNames}.
slots:
recipeNames: requestBody.recipeNames
- text: Remove the recipe scripts named {recipeNames}.
slots:
recipeNames: requestBody.recipeNames
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/createRecipe'].post
update:
x-apievangelist-phrasing:
intent: Create a recipe script
effect: write
questions:
- Can I register a custom script to run on all nodes of an instance group?
- What recipe types can I create for a cluster?
instructions:
- text: Create recipe {recipeName} of type {type} with script {recipeContent}.
slots:
recipeName: requestBody.recipeName
type: requestBody.type
recipeContent: requestBody.recipeContent
- text: Register a {type} recipe called {recipeName} running {recipeContent}, described as {description}.
slots:
type: requestBody.type
recipeName: requestBody.recipeName
recipeContent: requestBody.recipeContent
description: requestBody.description
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/describeRecipe'].post
update:
x-apievangelist-phrasing:
intent: Get details of a recipe
effect: read
questions:
- What does a particular recipe script contain?
- Can I view one recipe's type and content by name?
instructions:
- text: Describe recipe {recipeName}.
slots:
recipeName: requestBody.recipeName
- text: Show the script content of recipe {recipeName}.
slots:
recipeName: requestBody.recipeName
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/replaceRecipes'].post
update:
x-apievangelist-phrasing:
intent: Replace recipes on a Data Hub's instance groups
effect: write
questions:
- Can I swap the recipes attached to instance groups on an existing Data Hub?
- How do I change which recipes run on each host group of a running cluster?
instructions:
- text: Replace recipes on Data Hub {datahub} with {instanceGroupRecipes}.
slots:
datahub: requestBody.datahub
instanceGroupRecipes: requestBody.instanceGroupRecipes
- text: Set the instance group recipes of {datahub} to {instanceGroupRecipes}.
slots:
datahub: requestBody.datahub
instanceGroupRecipes: requestBody.instanceGroupRecipes
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/listClusterDefinitions'].post
update:
x-apievangelist-phrasing:
intent: List cluster definitions
effect: read
questions:
- Which cluster definitions can I use to create Data Hub clusters?
- What reusable cluster definitions exist in my account?
instructions:
- text: List all Data Hub cluster definitions.
- text: Show the reusable cluster definitions available to me.
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/deleteClusterDefinitions'].post
update:
x-apievangelist-phrasing:
intent: Delete cluster definitions
effect: destructive
questions:
- Can I delete cluster definitions I no longer need?
- Is it possible to remove several cluster definitions in one request?
instructions:
- text: Delete cluster definitions {clusterDefinitionNames}.
slots:
clusterDefinitionNames: requestBody.clusterDefinitionNames
- text: Remove the Data Hub cluster definitions named {clusterDefinitionNames}.
slots:
clusterDefinitionNames: requestBody.clusterDefinitionNames
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/createClusterDefinition'].post
update:
x-apievangelist-phrasing:
intent: Create a cluster definition
effect: write
questions:
- How do I save a reusable cluster definition for creating identical Data Hubs?
- What workload template does a new cluster definition need?
instructions:
- text: Create cluster definition {clusterDefinitionName} from workload template {workloadTemplate}.
slots:
clusterDefinitionName: requestBody.clusterDefinitionName
workloadTemplate: requestBody.workloadTemplate
- text: Save a cluster definition called {clusterDefinitionName} using {workloadTemplate} with description {description}.
slots:
clusterDefinitionName: requestBody.clusterDefinitionName
workloadTemplate: requestBody.workloadTemplate
description: requestBody.description
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/describeClusterDefinition'].post
update:
x-apievangelist-phrasing:
intent: Get details of a cluster definition
effect: read
questions:
- What's inside a particular cluster definition?
- Can I view one cluster definition's JSON by name?
instructions:
- text: Describe cluster definition {clusterDefinitionName}.
slots:
clusterDefinitionName: requestBody.clusterDefinitionName
- text: Show the JSON of cluster definition {clusterDefinitionName}.
slots:
clusterDefinitionName: requestBody.clusterDefinitionName
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/listClusterTemplates'].post
update:
x-apievangelist-phrasing:
intent: List cluster templates
effect: read
questions:
- Which cluster templates are available for Data Hub?
- What service layouts can I pick from when building a cluster?
instructions:
- text: List all Data Hub cluster templates.
- text: Show me the cluster templates I can create clusters from.
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/deleteClusterTemplates'].post
update:
x-apievangelist-phrasing:
intent: Delete cluster templates
effect: destructive
questions:
- Can I delete cluster templates that are no longer used?
- Is it possible to remove multiple cluster templates at once?
instructions:
- text: Delete cluster templates {clusterTemplateNames}.
slots:
clusterTemplateNames: requestBody.clusterTemplateNames
- text: Remove the Data Hub cluster templates named {clusterTemplateNames}.
slots:
clusterTemplateNames: requestBody.clusterTemplateNames
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/createClusterTemplate'].post
update:
x-apievangelist-phrasing:
intent: Create a cluster template
effect: write
questions:
- Can I upload my own cluster template JSON for Data Hub?
- Is it possible to tag a new cluster template?
instructions:
- text: Create cluster template {clusterTemplateName} with content {clusterTemplateContent}.
slots:
clusterTemplateName: requestBody.clusterTemplateName
clusterTemplateContent: requestBody.clusterTemplateContent
- text: Add cluster template {clusterTemplateName} from {clusterTemplateContent} tagged {tags}.
slots:
clusterTemplateName: requestBody.clusterTemplateName
clusterTemplateContent: requestBody.clusterTemplateContent
tags: requestBody.tags
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/describeClusterTemplate'].post
update:
x-apievangelist-phrasing:
intent: Get details of a cluster template
effect: read
questions:
- Which services does a particular cluster template include?
- Can I view a cluster template's content by name?
instructions:
- text: Describe cluster template {clusterTemplateName}.
slots:
clusterTemplateName: requestBody.clusterTemplateName
- text: Show the content of cluster template {clusterTemplateName}.
slots:
clusterTemplateName: requestBody.clusterTemplateName
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/createCustomConfigurations'].post
update:
x-apievangelist-phrasing:
intent: Create custom service configurations
effect: write
questions:
- Can I define custom service properties to apply when a Data Hub is created?
- Is it possible to tie custom configurations to a specific runtime version?
instructions:
- text: Create custom configurations {customConfigurationsName} with properties {configurations}.
slots:
customConfigurationsName: requestBody.customConfigurationsName
configurations: requestBody.configurations
- text: Create custom configurations {customConfigurationsName} with {configurations} for runtime {runtimeVersion}.
slots:
customConfigurationsName: requestBody.customConfigurationsName
configurations: requestBody.configurations
runtimeVersion: requestBody.runtimeVersion
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/deleteCustomConfigurations'].post
update:
x-apievangelist-phrasing:
intent: Delete custom configurations
effect: destructive
questions:
- Can I delete a set of custom configurations?
- What do I need to remove custom service properties I created?
instructions:
- text: Delete custom configurations {customConfigurations}.
slots:
customConfigurations: requestBody.customConfigurations
- text: Remove the custom configuration set {customConfigurations}.
slots:
customConfigurations: requestBody.customConfigurations
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/describeCustomConfigurations'].post
update:
x-apievangelist-phrasing:
intent: Get details of custom configurations
effect: read
questions:
- Which property values are in a given custom configuration set?
- Can I view one set of custom configurations by name or CRN?
instructions:
- text: Describe custom configurations {customConfigurations}.
slots:
customConfigurations: requestBody.customConfigurations
- text: Show the properties defined in custom configurations {customConfigurations}.
slots:
customConfigurations: requestBody.customConfigurations
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/listCustomConfigurations'].post
update:
x-apievangelist-phrasing:
intent: List custom configurations
effect: read
questions:
- Which custom configuration sets exist for my Data Hub clusters?
- Can I page through all custom configurations?
instructions:
- text: List all custom configurations.
- text: List custom configurations, {pageSize} per page.
slots:
pageSize: requestBody.pageSize
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/migrateZookeeperToKraft'].post
update:
x-apievangelist-phrasing:
intent: Start Kafka migration from ZooKeeper to KRaft
effect: write
questions:
- How do I move my Kafka cluster off ZooKeeper onto KRaft?
- Can I start a ZooKeeper-to-KRaft broker migration on a Data Hub?
instructions:
- text: Start the ZooKeeper to KRaft migration on cluster {crn}.
slots:
crn: requestBody.crn
- text: Begin migrating Kafka brokers on {crn} from ZooKeeper to KRaft.
slots:
crn: requestBody.crn
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/finalizeZookeeperToKraftMigration'].post
update:
x-apievangelist-phrasing:
intent: Finalize the ZooKeeper to KRaft migration
effect: destructive
questions:
- Once the KRaft migration looks good, how do I complete it?
- What's the final step to commit a ZooKeeper-to-KRaft migration?
instructions:
- text: Finalize the ZooKeeper to KRaft migration on cluster {crn}.
slots:
crn: requestBody.crn
- text: Complete and commit the KRaft migration for {crn}.
slots:
crn: requestBody.crn
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/datahub/rollbackZookeeperToKraftMigration'].post
update:
x-apievangelist-phrasing:
intent: Roll back the ZooKeeper to KRaft migration
effect: write
questions:
- Can I undo a ZooKeeper-to-KRaft migration that's in progress?
- What happens if I roll back the KRaft migration?
instructions:
- text: Roll back the ZooKeeper to KRaft migration on cluster {crn}.
slots:
crn: requestBody.crn
- text: Revert Kafka on {crn} to ZooKeeper.
slots:
crn: requestBody.crn
method: generated
generated: '2026-10-01'
# --- truncated at 32 KB (54 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cloudera/refs/heads/main/overlays/cloudera-data-hub-api-phrasing-overlay.yaml