API Evangelist conversational phrasing for Cloudera Environments Service Environments2 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 Environments Service Environments2 API
  version: 1.0.0
extends: openapi/cloudera-environments2-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: 104
- target: $.paths['/api/v1/environments2/getCredentialPrerequisites'].post
  update:
    x-apievangelist-phrasing:
      intent: Get credential prerequisites for a cloud provider
      effect: read
      questions:
      - What do I need to set up in my cloud account before creating a CDP credential?
      - Which policies does a commercial-cloud credential require for my provider?
      instructions:
      - text: Get the credential prerequisites for {cloudPlatform}.
        slots:
          cloudPlatform: requestBody.cloudPlatform
      - text: Show the role and policy prerequisites for a {cloudPlatform} credential.
        slots:
          cloudPlatform: requestBody.cloudPlatform
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/getGovCloudCredentialPrerequisites'].post
  update:
    x-apievangelist-phrasing:
      intent: Get GovCloud credential prerequisites
      effect: read
      questions:
      - What prerequisites apply to a GovCloud credential in CDP?
      - Which policies must exist before I create a credential for GovCloud?
      instructions:
      - text: Get GovCloud credential prerequisites for {cloudPlatform}.
        slots:
          cloudPlatform: requestBody.cloudPlatform
      - text: Show what a GovCloud credential on {cloudPlatform} needs set up first.
        slots:
          cloudPlatform: requestBody.cloudPlatform
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/createAWSEnvironment'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an AWS environment
      effect: write
      questions:
      - How do I create a new CDP environment in AWS commercial regions?
      - Can CDP create private subnets for me when I set up an AWS environment?
      instructions:
      - text: Create AWS environment {environmentName} in {region} using credential {credentialName}.
        slots:
          environmentName: requestBody.environmentName
          region: requestBody.region
          credentialName: requestBody.credentialName
      - text: Set up AWS environment {environmentName} with credential {credentialName} in {region}, inside VPC {vpcId}.
        slots:
          environmentName: requestBody.environmentName
          credentialName: requestBody.credentialName
          region: requestBody.region
          vpcId: requestBody.vpcId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/createAWSGovCloudEnvironment'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an AWS GovCloud environment
      effect: write
      questions:
      - How do I create a CDP environment in AWS GovCloud?
      - Can I give a network CIDR when creating a GovCloud environment?
      instructions:
      - text: Create AWS GovCloud environment {environmentName} in {region} with credential {credentialName}.
        slots:
          environmentName: requestBody.environmentName
          region: requestBody.region
          credentialName: requestBody.credentialName
      - text: Set up GovCloud environment {environmentName} in {region} using {credentialName} and network CIDR {networkCidr}.
        slots:
          environmentName: requestBody.environmentName
          region: requestBody.region
          credentialName: requestBody.credentialName
          networkCidr: requestBody.networkCidr
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/createAzureEnvironment'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an Azure environment
      effect: write
      questions:
      - What's needed to create a CDP environment on Azure?
      - Can my Azure environment use an existing resource group and availability zones?
      instructions:
      - text: Create Azure environment {environmentName} in {region} with credential {credentialName}.
        slots:
          environmentName: requestBody.environmentName
          region: requestBody.region
          credentialName: requestBody.credentialName
      - text: Set up Azure environment {environmentName} in {region} using {credentialName} in resource group {resourceGroupName}.
        slots:
          environmentName: requestBody.environmentName
          region: requestBody.region
          credentialName: requestBody.credentialName
          resourceGroupName: requestBody.resourceGroupName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/createGCPEnvironment'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a GCP environment
      effect: write
      questions:
      - How do I create a CDP environment on Google Cloud?
      - Can a GCP environment use a customer encryption key?
      instructions:
      - text: Create GCP environment {environmentName} in {region} with credential {credentialName}.
        slots:
          environmentName: requestBody.environmentName
          region: requestBody.region
          credentialName: requestBody.credentialName
      - text: Set up Google Cloud environment {environmentName} in {region} using {credentialName} and encryption key {encryptionKey}.
        slots:
          environmentName: requestBody.environmentName
          region: requestBody.region
          credentialName: requestBody.credentialName
          encryptionKey: requestBody.encryptionKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/createPrivateEnvironment'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Private Cloud environment
      effect: write
      questions:
      - How do I register an on-prem Private Cloud environment from Cloudera Manager?
      - Which Cloudera Manager clusters can I attach when creating a Private Cloud environment?
      instructions:
      - text: Create Private Cloud environment {environmentName} from Cloudera Manager at {address} as {user} with clusters {clusterNames}.
        slots:
          environmentName: requestBody.environmentName
          address: requestBody.address
          user: requestBody.user
          clusterNames: requestBody.clusterNames
      - text: Register private environment {environmentName} using Cloudera Manager {address}, user {user}, token {authenticationToken}, clusters {clusterNames}.
        slots:
          environmentName: requestBody.environmentName
          address: requestBody.address
          user: requestBody.user
          authenticationToken: requestBody.authenticationToken
          clusterNames: requestBody.clusterNames
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/createAWSCredential'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an AWS credential
      effect: write
      questions:
      - How do I give CDP access to my AWS account with a cross-account role?
      - What IAM role ARN does a new AWS credential need?
      instructions:
      - text: Create AWS credential {credentialName} with role ARN {roleArn}.
        slots:
          credentialName: requestBody.credentialName
          roleArn: requestBody.roleArn
      - text: Add a new commercial AWS credential named {credentialName} for role {roleArn}.
        slots:
          credentialName: requestBody.credentialName
          roleArn: requestBody.roleArn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/createAWSGovCloudCredential'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an AWS GovCloud credential
      effect: write
      questions:
      - How do I create a credential for AWS GovCloud in CDP?
      - Does a GovCloud credential also use a cross-account role ARN?
      instructions:
      - text: Create GovCloud credential {credentialName} with role ARN {roleArn}.
        slots:
          credentialName: requestBody.credentialName
          roleArn: requestBody.roleArn
      - text: Add an AWS GovCloud credential named {credentialName} using role {roleArn}.
        slots:
          credentialName: requestBody.credentialName
          roleArn: requestBody.roleArn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/createAzureCredential'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an Azure credential
      effect: write
      questions:
      - What do I need to create an Azure credential for CDP?
      - Can I make an app-based Azure credential tied to a specific subscription and tenant?
      instructions:
      - text: Create Azure credential {credentialName} for subscription {subscriptionId} and tenant {tenantId}.
        slots:
          credentialName: requestBody.credentialName
          subscriptionId: requestBody.subscriptionId
          tenantId: requestBody.tenantId
      - text: Add a new app-based Azure credential named {credentialName} with app details {appBased}.
        slots:
          credentialName: requestBody.credentialName
          appBased: requestBody.appBased
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/updateAzureCredential'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a certificate-based Azure credential
      effect: write
      questions:
      - Can I change the subscription or tenant on an existing certificate-based Azure credential?
      - How do I refresh the app details on an Azure credential I already have?
      instructions:
      - text: Update existing Azure credential {credentialName} to subscription {subscriptionId}, tenant {tenantId}, app {appBased}.
        slots:
          credentialName: requestBody.credentialName
          subscriptionId: requestBody.subscriptionId
          tenantId: requestBody.tenantId
          appBased: requestBody.appBased
      - text: Modify the certificate-based Azure credential {credentialName} for tenant {tenantId}, subscription {subscriptionId}, app {appBased}.
        slots:
          credentialName: requestBody.credentialName
          tenantId: requestBody.tenantId
          subscriptionId: requestBody.subscriptionId
          appBased: requestBody.appBased
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/updateAwsCredential'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an existing AWS credential
      effect: write
      questions:
      - How do I point an existing AWS credential at a new role ARN?
      - Can permissions be verified when I update an AWS credential?
      instructions:
      - text: Update existing AWS credential {credentialName} to use role {roleArn}.
        slots:
          credentialName: requestBody.credentialName
          roleArn: requestBody.roleArn
      - text: Swap the role on AWS credential {credentialName} to {roleArn} and verify its permissions.
        slots:
          credentialName: requestBody.credentialName
          roleArn: requestBody.roleArn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/createGCPCredential'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a GCP credential
      effect: write
      questions:
      - How do I give CDP access to my Google Cloud project?
      - What service account key does a GCP credential need?
      instructions:
      - text: Create GCP credential {credentialName} with service account key {credentialKey}.
        slots:
          credentialName: requestBody.credentialName
          credentialKey: requestBody.credentialKey
      - text: Add a Google Cloud credential named {credentialName} using key {credentialKey}.
        slots:
          credentialName: requestBody.credentialName
          credentialKey: requestBody.credentialKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/changeEnvironmentCredential'].post
  update:
    x-apievangelist-phrasing:
      intent: Switch the credential an environment uses
      effect: write
      questions:
      - Can I swap which credential an existing environment uses?
      - How do I move an environment onto a different cloud credential?
      instructions:
      - text: Change environment {environmentName} to use credential {credentialName}.
        slots:
          environmentName: requestBody.environmentName
          credentialName: requestBody.credentialName
      - text: Switch {environmentName} over to credential {credentialName}.
        slots:
          environmentName: requestBody.environmentName
          credentialName: requestBody.credentialName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/updateAzureEncryptionResources'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable customer-managed keys on an Azure environment
      effect: write
      questions:
      - How do I turn on server-side encryption with my own key for an existing Azure environment?
      - Can I add a user-managed identity for Azure disk encryption later?
      instructions:
      - text: Set Azure encryption key {encryptionKeyUrl} on environment {environment}.
        slots:
          encryptionKeyUrl: requestBody.encryptionKeyUrl
          environment: requestBody.environment
      - text: Enable CMK encryption for Azure environment {environment} with key {encryptionKeyUrl} in resource group {encryptionKeyResourceGroupName}.
        slots:
          environment: requestBody.environment
          encryptionKeyUrl: requestBody.encryptionKeyUrl
          encryptionKeyResourceGroupName: requestBody.encryptionKeyResourceGroupName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/updateAzureDatabaseResources'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable private Flexible Server on an Azure environment
      effect: write
      questions:
      - How do I deploy a private Azure Flexible Server database for an existing environment?
      - Can I set the private DNS zone used for the environment's database?
      instructions:
      - text: Update Azure environment {environment} to use Flexible Server subnets {flexibleServerSubnetIds}.
        slots:
          environment: requestBody.environment
          flexibleServerSubnetIds: requestBody.flexibleServerSubnetIds
      - text: Set database private DNS zone {databasePrivateDnsZoneId} on Azure environment {environment}.
        slots:
          databasePrivateDnsZoneId: requestBody.databasePrivateDnsZoneId
          environment: requestBody.environment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/updateAzureAvailabilityZones'].post
  update:
    x-apievangelist-phrasing:
      intent: Change availability zones for an Azure environment
      effect: write
      questions:
      - Can I change which availability zones my Azure environment spreads across?
      - How do I add zones to an existing Azure environment?
      instructions:
      - text: Set availability zones {availabilityZones} on Azure environment {environment}.
        slots:
          availabilityZones: requestBody.availabilityZones
          environment: requestBody.environment
      - text: Update the Azure zones for {environment} to {availabilityZones}.
        slots:
          environment: requestBody.environment
          availabilityZones: requestBody.availabilityZones
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/updateAwsDiskEncryptionParameters'].post
  update:
    x-apievangelist-phrasing:
      intent: Set the AWS encryption key for an environment
      effect: write
      questions:
      - How do I enable KMS customer-managed key encryption on an existing AWS environment?
      - Will a new encryption key ARN apply to resources already created?
      instructions:
      - text: Set encryption key ARN {encryptionKeyArn} on AWS environment {environment}.
        slots:
          encryptionKeyArn: requestBody.encryptionKeyArn
          environment: requestBody.environment
      - text: Turn on CMK disk encryption for {environment} with key {encryptionKeyArn}.
        slots:
          environment: requestBody.environment
          encryptionKeyArn: requestBody.encryptionKeyArn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/deleteEnvironment'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete an environment
      effect: destructive
      questions:
      - How do I delete a CDP environment I no longer need?
      - Can deleting an environment also cascade to its attached clusters?
      instructions:
      - text: Delete environment {environmentName}.
        slots:
          environmentName: requestBody.environmentName
      - text: Delete environment {environmentName} and everything attached to it.
        slots:
          environmentName: requestBody.environmentName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/deleteCredential'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a credential
      effect: destructive
      questions:
      - How do I remove an environment credential I no longer use?
      - Is deleting a credential permanent?
      instructions:
      - text: Delete credential {credentialName}.
        slots:
          credentialName: requestBody.credentialName
      - text: Remove the environment credential called {credentialName}.
        slots:
          credentialName: requestBody.credentialName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/listEnvironments'].post
  update:
    x-apievangelist-phrasing:
      intent: List environments
      effect: read
      questions:
      - Which CDP environments exist in my account?
      - What environments do I have across all clouds?
      instructions:
      - text: List all my environments.
      - text: Show every environment in the account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/listCredentials'].post
  update:
    x-apievangelist-phrasing:
      intent: List environment credentials
      effect: read
      questions:
      - Which cloud credentials are registered for my environments?
      - Can I look up one credential by name?
      instructions:
      - text: List my environment credentials.
      - text: Find the credential named {credentialName}.
        slots:
          credentialName: requestBody.credentialName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/describeEnvironment'].post
  update:
    x-apievangelist-phrasing:
      intent: Describe an environment
      effect: read
      questions:
      - What's the status and configuration of a specific environment?
      - Can I see the network and region details of one environment?
      instructions:
      - text: Describe environment {environmentName}.
        slots:
          environmentName: requestBody.environmentName
      - text: Show me the full details of {environmentName}.
        slots:
          environmentName: requestBody.environmentName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/syncAllUsers'].post
  update:
    x-apievangelist-phrasing:
      intent: Sync all users and groups to environments
      effect: write
      questions:
      - How do I push all user and group changes out to my environments?
      - Can I limit a full user sync to certain environments?
      instructions:
      - text: Sync all users and groups to every environment.
      - text: Run a full user and group sync on environments {environmentNames}.
        slots:
          environmentNames: requestBody.environmentNames
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/syncUser'].post
  update:
    x-apievangelist-phrasing:
      intent: Sync the current user to FreeIPA
      effect: write
      questions:
      - Can I sync just my own user to the FreeIPA servers without a full sync?
      - Is there a single-user sync for environments?
      instructions:
      - text: Sync my user to the FreeIPA servers in all environments.
      - text: Push only my user account out to FreeIPA.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/syncStatus'].post
  update:
    x-apievangelist-phrasing:
      intent: Check status of a user sync operation
      effect: read
      questions:
      - Did the user sync I started finish successfully?
      - How do I check a sync operation by its operation ID?
      instructions:
      - text: Get the status of user sync operation {operationId}.
        slots:
          operationId: requestBody.operationId
      - text: Check whether sync {operationId} has completed.
        slots:
          operationId: requestBody.operationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/lastSyncStatus'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the last user sync status for an environment
      effect: read
      questions:
      - When did user sync last run for this environment, and did it work?
      - Can I see the most recent sync result by environment CRN?
      instructions:
      - text: Show the last user sync status for environment {envNameOrCrn}.
        slots:
          envNameOrCrn: requestBody.envNameOrCrn
      - text: Get the most recent sync outcome for {environment}.
        slots:
          environment: requestBody.environment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/listConnectedDataServices'].post
  update:
    x-apievangelist-phrasing:
      intent: List data services attached to an environment
      effect: read
      questions:
      - Which data services and clusters are running in my environment?
      - What would be affected if I deleted this environment?
      instructions:
      - text: List the data services attached to {environment}.
        slots:
          environment: requestBody.environment
      - text: Show connected data service clusters in environment {environment}.
        slots:
          environment: requestBody.environment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/getEnvironmentUserSyncState'].post
  update:
    x-apievangelist-phrasing:
      intent: Get an environment's user sync state
      effect: read
      questions:
      - Is user synchronization in a healthy state for my environment?
      - Does this environment need a user sync?
      instructions:
      - text: Get the user sync state of {environmentName}.
        slots:
          environmentName: requestBody.environmentName
      - text: Check if {environmentName} is in sync with users and groups.
        slots:
          environmentName: requestBody.environmentName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/setPassword'].post
  update:
    x-apievangelist-phrasing:
      intent: Set a workload password (deprecated)
      effect: write
      questions:
      - Is there an older environments call for setting my workload password?
      - Can I set my workload password for only certain environments?
      instructions:
      - text: Set my workload password to {password} using the deprecated environments call.
        slots:
          password: requestBody.password
      - text: Update my workload password to {password} in environments {environmentCRNs}.
        slots:
          password: requestBody.password
          environmentCRNs: requestBody.environmentCRNs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/getRootCertificate'].post
  update:
    x-apievangelist-phrasing:
      intent: Get an environment's root certificate
      effect: read
      questions:
      - Where can I download the root CA certificate for my environment?
      - Which certificate do clients need to trust to connect over TLS?
      instructions:
      - text: Get the root certificate for {environmentName}.
        slots:
          environmentName: requestBody.environmentName
      - text: Download the public root CA cert of environment {environmentName}.
        slots:
          environmentName: requestBody.environmentName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/getKeytab'].post
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a Kerberos keytab
      effect: read
      questions:
      - How do I get a keytab for my user in an environment?
      - Can I retrieve a keytab for a machine user?
      instructions:
      - text: Get my keytab for environment {environmentName}.
        slots:
          environmentName: requestBody.environmentName
      - text: Retrieve the keytab for {actorCrn} in {environmentName}.
        slots:
          actorCrn: requestBody.actorCrn
          environmentName: requestBody.environmentName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/getAutomatedSyncEnvironmentStatus'].post
  update:
    x-apievangelist-phrasing:
      intent: Get automated user sync status
      effect: read
      questions:
      - Is automated user sync turned on and working for my environment?
      - What does the automatic sync report for this environment?
      instructions:
      - text: Get the automated sync status for {environmentName}.
        slots:
          environmentName: requestBody.environmentName
      - text: Check automatic user sync on environment {environmentName}.
        slots:
          environmentName: requestBody.environmentName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/getIdBrokerMappings'].post
  update:
    x-apievangelist-phrasing:
      intent: Get ID Broker mappings for an environment
      effect: read
      questions:
      - Which cloud roles are users and groups mapped to through ID Broker?
      - What data access role does my environment's ID Broker use?
      instructions:
      - text: Show the ID Broker mappings for {environmentName}.
        slots:
          environmentName: requestBody.environmentName
      - text: Get all user and group role mappings in ID Broker for {environmentName}.
        slots:
          environmentName: requestBody.environmentName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/setIdBrokerMappings'].post
  update:
    x-apievangelist-phrasing:
      intent: Set ID Broker mappings for an environment
      effect: write
      questions:
      - How do I map users and groups to cloud roles in ID Broker?
      - Will setting ID Broker mappings overwrite the ones already there?
      instructions:
      - text: Set ID Broker mappings on {environmentName} with data access role {dataAccessRole}.
        slots:
          environmentName: requestBody.environmentName
          dataAccessRole: requestBody.dataAccessRole
      - text: Replace the ID Broker mappings for {environmentName} with {mappings}, using data access role {dataAccessRole}.
        slots:
          environmentName: requestBody.environmentName
          mappings: requestBody.mappings
          dataAccessRole: requestBody.dataAccessRole
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/syncIdBrokerMappings'].post
  update:
    x-apievangelist-phrasing:
      intent: Push ID Broker mappings to data lakes
      effect: write
      questions:
      - How do I apply my ID Broker mapping changes to the data lake clusters?
      - Do ID Broker mappings need syncing after I change them?
      instructions:
      - text: Sync ID Broker mappings to the data lakes in {environmentName}.
        slots:
          environmentName: requestBody.environmentName
      - text: Push the current ID Broker mappings out for environment {environmentName}.
        slots:
          environmentName: requestBody.environmentName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/getIdBrokerMappingsSyncStatus'].post
  update:
    x-apievangelist-phrasing:
      intent: Check ID Broker mappings sync status
      effect: read
      questions:
      - Did my last ID Broker mappings sync succeed?
      - Are the ID Broker mappings still syncing to the data lake?
      instructions:
      - text: Get the ID Broker mappings sync status for {environmentName}.
        slots:
          environmentName: requestBody.environmentName
      - text: Check the most recent ID Broker sync result in {environmentName}.
        slots:
          environmentName: requestBody.environmentName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/startEnvironment'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an environment
      effect: write
      questions:
      - How do I start a stopped environment?
      - Can I start the Data Hub clusters along with the environment?
      instructions:
      - text: Start environment {environmentName}.
        slots:
          environmentName: requestBody.environmentName
      - text: Start {environmentName} and its Data Hub clusters too.
        slots:
          environmentName: requestBody.environmentName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/stopEnvironment'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop an environment
      effect: write
      questions:
      - Can I stop an environment to save cloud costs?
      - What's the way to pause a whole CDP environment?
      instructions:
      - text: Stop environment {environmentName}.
        slots:
          environmentName: requestBody.environmentName
      - text: Pause {environmentName} until I need it again.
        slots:
          environmentName: requestBody.environmentName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/getOperation'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the latest operation on an environment
      effect: read
      questions:
      - What operation is currently running on my environment?
      - Did the last environment operation finish or fail?
      instructions:
      - text: Get the latest operation for environment {environmentName}.
        slots:
          environmentName: requestBody.environmentName
      - text: Show progress of operation {operationId} on {environmentName}.
        slots:
          operationId: requestBody.operationId
          environmentName: requestBody.environmentName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/environments2/checkEnvironmentConnectivity'].post
  update:
    x-apievangelist-phrasing:
      intent: Test connectivity to Cloudera Manager
      effect: read
      questions:
      - Can CDP reach my Cloudera Manager before I create a Private Cloud environment?
      - How do I test Cloudera Manager credentials ahead of registering an environment?
      instructions:
      - text: Check connectivity to Cloudera Manager at {address} as {user} with token {authenticationToken}.
        slots:
          address: requestBody.address
          user: requestBody.user
          authenticationToken: requestBody.authenticationToken
      - text: Test whether Cloudera Manager {address} accepts login {user} using token {authenticationToken}.
        slots:
          address: requestBody.address
          user: requestBody.user
          authenticationToken: requestBody.authenticationToken
      method: generated
      generated: '2026-10-01'


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