API Evangelist conversational phrasing for Cloudera DataFlow Workload Service CDF Local RPCAPI…

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cloudera DataFlow Workload Service CDF Local RPCAPI…
  version: 1.0.0
extends: openapi/cloudera-cdflocalrpcapiversion1-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: 71
- target: $.paths['/dfx/api/rpc-v1/custom-nar-configurations/create-custom-nar-configuration'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom NAR configuration
      effect: write
      questions:
      - How do I point DataFlow at a storage location holding my custom NiFi NAR files?
      - What credentials does a new custom NAR configuration need for its storage location?
      instructions:
      - text: Create a custom NAR configuration in environment {environment} using storage location {storage} with user {username}.
        slots:
          environment: requestBody.environmentCrn
          storage: requestBody.storageLocation
          username: requestBody.username
      - text: Set up a new custom NAR configuration for project {project} in environment {environment}.
        slots:
          project: requestBody.projectCrn
          environment: requestBody.environmentCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dfx/api/rpc-v1/custom-nar-configurations/delete-custom-nar-configuration'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete an orphaned custom NAR configuration
      effect: destructive
      questions:
      - Can I remove a custom NAR configuration that no deployment uses anymore?
      - How do I clean up an orphaned custom NAR configuration in DataFlow?
      instructions:
      - text: Delete orphaned custom NAR configuration {config} in environment {environment}.
        slots:
          config: requestBody.customNarConfigurationCrn
          environment: requestBody.environmentCrn
      - text: Remove the unused custom NAR configuration {config} at version {version}.
        slots:
          config: requestBody.customNarConfigurationCrn
          version: requestBody.configurationVersion
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dfx/api/rpc-v1/custom-nar-configurations/get-custom-nar-configuration'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a custom NAR configuration
      effect: read
      questions:
      - Which custom NAR configuration is a given flow deployment using?
      - Can I look up the details of one custom NAR configuration by its CRN?
      instructions:
      - text: Show the custom NAR configuration {config} in environment {environment}.
        slots:
          config: requestBody.customNarConfigurationCrn
          environment: requestBody.environmentCrn
      - text: Get the custom NAR configuration used by deployment {deployment}.
        slots:
          deployment: requestBody.deploymentCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dfx/api/rpc-v1/custom-nar-configurations/get-default-custom-nar-configuration'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the default custom NAR configuration (deprecated)
      effect: read
      questions:
      - Is there still a default custom NAR configuration for an environment?
      - What does the deprecated default custom NAR configuration call return?
      instructions:
      - text: Fetch the default custom NAR configuration for environment {environment} using the deprecated call.
        slots:
          environment: requestBody.environmentCrn
      - text: Check the legacy default NAR configuration of environment {environment}.
        slots:
          environment: requestBody.environmentCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dfx/api/rpc-v1/custom-nar-configurations/update-custom-nar-configuration'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a custom NAR configuration
      effect: write
      questions:
      - Can I change the storage location or password on an existing custom NAR configuration?
      - How do I rotate the credentials of a custom NAR configuration I already created?
      instructions:
      - text: Update custom NAR configuration {config} to use storage location {storage}.
        slots:
          config: requestBody.crn
          storage: requestBody.storageLocation
      - text: Change the username on the custom NAR configuration in environment {environment} to {username}.
        slots:
          environment: requestBody.environmentCrn
          username: requestBody.username
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dfx/api/rpc-v1/custom-nar-configurations/validate-custom-nar-configuration'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate custom NAR configuration settings
      effect: read
      questions:
      - Can I test whether my NAR storage location and credentials work before saving them?
      - Will DataFlow be able to reach my custom NAR files with these credentials?
      instructions:
      - text: Validate custom NAR settings for storage location {storage} with user {username} in environment {environment}.
        slots:
          storage: requestBody.storageLocation
          username: requestBody.username
          environment: requestBody.environmentCrn
      - text: Check that the NAR storage at {storage} is reachable before I create the configuration.
        slots:
          storage: requestBody.storageLocation
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dfx/api/rpc-v1/custom-python-configurations/create-custom-python-configuration'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom Python configuration
      effect: write
      questions:
      - How do I give DataFlow access to my own Python processors in cloud storage?
      - What is required to register a custom Python configuration for an environment?
      instructions:
      - text: Create a custom Python configuration in environment {environment} pointing at {storage} with user {username}.
        slots:
          environment: requestBody.environmentCrn
          storage: requestBody.storageLocation
          username: requestBody.username
      - text: Register a custom Python configuration for project {project}.
        slots:
          project: requestBody.projectCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dfx/api/rpc-v1/custom-python-configurations/delete-custom-python-configuration'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete an orphaned custom Python configuration
      effect: destructive
      questions:
      - Can I delete a custom Python configuration that is no longer attached to anything?
      - How do I get rid of an orphaned custom Python configuration?
      instructions:
      - text: Delete orphaned custom Python configuration {config} in environment {environment}.
        slots:
          config: requestBody.customPythonConfigurationCrn
          environment: requestBody.environmentCrn
      - text: Remove unused custom Python configuration {config} at version {version}.
        slots:
          config: requestBody.customPythonConfigurationCrn
          version: requestBody.configurationVersion
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dfx/api/rpc-v1/custom-python-configurations/get-custom-python-configuration'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a custom Python configuration
      effect: read
      questions:
      - Which custom Python configuration does a given deployment rely on?
      - Can I see the storage location set on one custom Python configuration?
      instructions:
      - text: Show custom Python configuration {config} in environment {environment}.
        slots:
          config: requestBody.customPythonConfigurationCrn
          environment: requestBody.environmentCrn
      - text: Get the custom Python configuration used by deployment {deployment}.
        slots:
          deployment: requestBody.deploymentCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dfx/api/rpc-v1/custom-python-configurations/update-custom-python-configuration'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a custom Python configuration
      effect: write
      questions:
      - Can I move an existing custom Python configuration to a different storage location?
      - How do I change the password on my custom Python configuration?
      instructions:
      - text: Update custom Python configuration {config} to read from {storage}.
        slots:
          config: requestBody.crn
          storage: requestBody.storageLocation
      - text: Change the user on custom Python configuration {config} to {username}.
        slots:
          config: requestBody.crn
          username: requestBody.username
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dfx/api/rpc-v1/custom-python-configurations/validate-custom-python-configuration'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate custom Python configuration settings
      effect: read
      questions:
      - Can I check my Python processor storage credentials before creating the configuration?
      - Will these settings work for a custom Python configuration?
      instructions:
      - text: Validate custom Python settings for storage {storage} with user {username} in environment {environment}.
        slots:
          storage: requestBody.storageLocation
          username: requestBody.username
          environment: requestBody.environmentCrn
      - text: Test that the Python processor location {storage} is accessible.
        slots:
          storage: requestBody.storageLocation
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dfx/api/rpc-v1/deployed-flows/abort-flow-request-in-deployment'].post
  update:
    x-apievangelist-phrasing:
      intent: Abort a flow request in a deployment
      effect: destructive
      questions:
      - Can I back out of adding a flow to a deployment before it finishes?
      - How do I abandon a pending deployed-flow request?
      instructions:
      - text: Abort deployed flow request {request} in environment {environment}.
        slots:
          request: requestBody.deployedFlowRequestCrn
          environment: requestBody.environmentCrn
      - text: Cancel the in-progress flow request {request}.
        slots:
          request: requestBody.deployedFlowRequestCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dfx/api/rpc-v1/deployed-flows/add-flow-to-deployment'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a flow to an existing deployment
      effect: write
      questions:
      - Can I run more than one NiFi flow inside the same DataFlow deployment?
      - Is it possible to add a flow to a deployment without starting it automatically?
      instructions:
      - text: Add flow {name} to deployment {deployment} using flow request {request}.
        slots:
          name: requestBody.name
          deployment: requestBody.deploymentCrn
          request: requestBody.deployedFlowRequestCrn
      - text: Add flow {name} to deployment {deployment} and start it right away ({autostart}).
        slots:
          name: requestBody.name
          deployment: requestBody.deploymentCrn
          autostart: requestBody.autoStartFlow
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dfx/api/rpc-v1/deployed-flows/cancel-change-flow-version-in-deployment'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a flow version change for a deployed flow
      effect: destructive
      questions:
      - Can I stop a version change on one flow inside a multi-flow deployment?
      - What happens if I cancel a flow version change that is still running?
      instructions:
      - text: Cancel the version change for deployed flow {flow} in deployment {deployment}.
        slots:
          flow: requestBody.deployedFlowCrn
          deployment: requestBody.deploymentCrn
      - text: Stop changing the version of flow {flow} in environment {environment}.
        slots:
          flow: requestBody.deployedFlowCrn
          environment: requestBody.environmentCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dfx/api/rpc-v1/deployed-flows/change-flow-version-in-deployment'].post
  update:
    x-apievangelist-phrasing:
      intent: Change the version of a deployed flow
      effect: write
      questions:
      - How do I roll a running deployed flow onto a newer flow definition version?
      - Can I choose a strategy and a stop timeout when switching one flow's version?
      instructions:
      - text: Change the version of deployed flow {flow} in deployment {deployment}.
        slots:
          flow: requestBody.deployedFlowCrn
          deployment: requestBody.deploymentCrn
      - text: Switch flow {flow} to its new version using strategy {strategy}, waiting {minutes} minutes for it to stop.
        slots:
          flow: requestBody.deployedFlowCrn
          strategy: requestBody.strategy
          minutes: requestBody.waitForFlowToStopInMinutes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dfx/api/rpc-v1/deployed-flows/get-flow-configuration-in-deployment'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a deployed flow's configuration
      effect: read
      questions:
      - What parameters and KPIs is one flow inside my deployment configured with?
      - Can I read back the configuration of a single deployed flow?
      instructions:
      - text: Show the configuration of deployed flow {flow} in deployment {deployment}.
        slots:
          flow: requestBody.deployedFlowCrn
          deployment: requestBody.deploymentCrn
      - text: Get the flow configuration for {flow} in environment {environment}.
        slots:
          flow: requestBody.deployedFlowCrn
          environment: requestBody.environmentCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dfx/api/rpc-v1/deployed-flows/get-flow-configuration-metadata-in-deployment'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a deployed flow's configuration metadata
      effect: read
      questions:
      - Where can I find metadata about a deployed flow's configuration rather than the configuration itself?
      - Which configuration version is a given deployed flow on?
      instructions:
      - text: Get the configuration metadata of deployed flow {flow} in deployment {deployment}.
        slots:
          flow: requestBody.deployedFlowCrn
          deployment: requestBody.deploymentCrn
      - text: Fetch configuration metadata for flow {flow}.
        slots:
          flow: requestBody.deployedFlowCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dfx/api/rpc-v1/deployed-flows/get-flow-request-details-in-deployment'].post
  update:
    x-apievangelist-phrasing:
      intent: Get and register a flow request in a deployment
      effect: write
      questions:
      - How do I register a request to add a flow into an existing deployment?
      - What details come back for a deployed-flow request?
      instructions:
      - text: Get the details of deployed flow request {request} and register it.
        slots:
          request: requestBody.deployedFlowRequestCrn
      - text: Register flow request {request} in environment {environment}.
        slots:
          request: requestBody.deployedFlowRequestCrn
          environment: requestBody.environmentCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dfx/api/rpc-v1/deployed-flows/import-flow-into-deployment'].post
  update:
    x-apievangelist-phrasing:
      intent: Import a flow configuration into a deployment
      effect: write
      questions:
      - Can I bring one flow from an exported archive into an existing deployment?
      - Which archive and flow name do I need to import a flow into a deployment?
      instructions:
      - text: Import flow {flow} from archive {archive} into the deployment for request {request}.
        slots:
          flow: requestBody.flowName
          archive: requestBody.archiveName
          request: requestBody.deployedFlowRequestCrn
      - text: Load flow {flow} from exported archive {archive} as an additional deployed flow.
        slots:
          flow: requestBody.flowName
          archive: requestBody.archiveName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dfx/api/rpc-v1/deployed-flows/start-flow-in-deployment'].post
  update:
    x-apievangelist-phrasing:
      intent: Start one flow in a deployment
      effect: write
      questions:
      - How do I start a single NiFi flow without starting every flow in the deployment?
      - Can I resume processing on one deployed flow that I stopped?
      instructions:
      - text: Start deployed flow {flow} in deployment {deployment}.
        slots:
          flow: requestBody.deployedFlowCrn
          deployment: requestBody.deploymentCrn
      - text: Turn flow {flow} back on in environment {environment}.
        slots:
          flow: requestBody.deployedFlowCrn
          environment: requestBody.environmentCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dfx/api/rpc-v1/deployed-flows/stop-flow-in-deployment'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop one flow in a deployment
      effect: write
      questions:
      - Can I stop just one NiFi flow while the rest of the deployment keeps running?
      - How long will DataFlow wait for a single deployed flow to stop?
      instructions:
      - text: Stop deployed flow {flow} in deployment {deployment}.
        slots:
          flow: requestBody.deployedFlowCrn
          deployment: requestBody.deploymentCrn
      - text: Stop flow {flow} and wait up to {minutes} minutes for it to drain.
        slots:
          flow: requestBody.deployedFlowCrn
          minutes: requestBody.waitForFlowToStopInMinutes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dfx/api/rpc-v1/deployed-flows/terminate-flow-in-deployment'].post
  update:
    x-apievangelist-phrasing:
      intent: Terminate one flow in a deployment
      effect: destructive
      questions:
      - How do I permanently remove one flow from a multi-flow deployment?
      - Can I terminate a single deployed flow without terminating the whole deployment?
      instructions:
      - text: Terminate deployed flow {flow} in deployment {deployment}.
        slots:
          flow: requestBody.deployedFlowCrn
          deployment: requestBody.deploymentCrn
      - text: Remove flow {flow} from its deployment in environment {environment}.
        slots:
          flow: requestBody.deployedFlowCrn
          environment: requestBody.environmentCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dfx/api/rpc-v1/deployed-flows/update-flow-in-deployment'].post
  update:
    x-apievangelist-phrasing:
      intent: Update one flow in a deployment
      effect: write
      questions:
      - Can I change parameter groups or KPIs on one flow inside a deployment?
      - Which settings of a single deployed flow can I update in place?
      instructions:
      - text: Update the parameter groups of deployed flow {flow} in deployment {deployment}.
        slots:
          flow: requestBody.deployedFlowCrn
          deployment: requestBody.deploymentCrn
      - text: Apply new KPIs {kpis} to flow {flow} at configuration version {version}.
        slots:
          kpis: requestBody.kpis
          flow: requestBody.deployedFlowCrn
          version: requestBody.configurationVersion
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dfx/api/rpc-v1/deployments/abort-asset-update-request'].post
  update:
    x-apievangelist-phrasing:
      intent: Abort an asset update request
      effect: destructive
      questions:
      - Can I throw away an asset update request I started for a deployment?
      - How do I abandon pending asset changes on a deployment?
      instructions:
      - text: Abort asset update request {request} on deployment {deployment}.
        slots:
          request: requestBody.assetUpdateRequestCrn
          deployment: requestBody.deploymentCrn
      - text: Discard the asset update request {request} for flow {flow}.
        slots:
          request: requestBody.assetUpdateRequestCrn
          flow: requestBody.deployedFlowCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dfx/api/rpc-v1/deployments/abort-deployment-request'].post
  update:
    x-apievangelist-phrasing:
      intent: Abort a deployment request
      effect: destructive
      questions:
      - Can I cancel a deployment request before the deployment is created?
      - How do I abandon a half-finished deployment request?
      instructions:
      - text: Abort deployment request {request} in environment {environment}.
        slots:
          request: requestBody.deploymentRequestCrn
          environment: requestBody.environmentCrn
      - text: Drop the pending deployment request {request}.
        slots:
          request: requestBody.deploymentRequestCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dfx/api/rpc-v1/deployments/cancel-change-flow-version'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a deployment's flow version change (legacy)
      effect: destructive
      questions:
      - Is there an older deployment-level call to cancel a flow version change?
      - Can I still cancel a version change for a whole single-flow deployment the legacy way?
      instructions:
      - text: Cancel the flow version change on deployment {deployment} using the deprecated deployment-level call.
        slots:
          deployment: requestBody.deploymentCrn
      - text: Use the legacy endpoint to stop the version change on deployment {deployment} in {environment}.
        slots:
          deployment: requestBody.deploymentCrn
          environment: requestBody.environmentCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dfx/api/rpc-v1/deployments/cancel-nifi-version-update'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a NiFi version update
      effect: destructive
      questions:
      - Can I back out of a NiFi version upgrade that is in progress on a deployment?
      - How do I cancel an ongoing NiFi runtime update?
      instructions:
      - text: Cancel the NiFi version update on deployment {deployment}.
        slots:
          deployment: requestBody.deploymentCrn
      - text: Stop the NiFi upgrade running on deployment {deployment} in environment {environment}.
        slots:
          deployment: requestBody.deploymentCrn
          environment: requestBody.environmentCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dfx/api/rpc-v1/deployments/change-flow-version'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a deployment's flow version (legacy)
      effect: write
      questions:
      - Is there a deprecated way to change the flow version of a whole deployment?
      - Which legacy call changes the flow version on a single-flow deployment?
      instructions:
      - text: Change the flow version of deployment {deployment} using the deprecated deployment-level call.
        slots:
          deployment: requestBody.deploymentCrn
      - text: Use the legacy endpoint to move deployment {deployment} to a new flow version with strategy {strategy}.
        slots:
          deployment: requestBody.deploymentCrn
          strategy: requestBody.strategy
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dfx/api/rpc-v1/deployments/create-asset-update-request'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an asset update request for a deployment
      effect: write
      questions:
      - How do I begin replacing files and assets used by a running deployment?
      - What do I need before uploading new assets to an existing deployment?
      instructions:
      - text: Create an asset update request for deployment {deployment}.
        slots:
          deployment: requestBody.deploymentCrn
      - text: Open an asset update request for flow {flow} in deployment {deployment}.
        slots:
          flow: requestBody.deployedFlowCrn
          deployment: requestBody.deploymentCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dfx/api/rpc-v1/deployments/create-deployment'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a flow deployment
      effect: write
      questions:
      - How do I deploy a NiFi flow to DataFlow with autoscaling between a minimum and maximum node count?
      - Can I pick the NiFi version and cluster size when creating a deployment?
      - Is it possible to restrict inbound connections to certain IP ranges on a new deployment?
      instructions:
      - text: Create deployment {name} in environment {environment} from deployment request {request}.
        slots:
          name: requestBody.name
          environment: requestBody.environmentCrn
          request: requestBody.deploymentRequestCrn
      - text: Create deployment {name} with autoscaling from {min} to {max} nodes.
        slots:
          name: requestBody.name
          min: requestBody.autoScaleMinNodes
          max: requestBody.autoScaleMaxNodes
      - text: Deploy {name} on NiFi version {nifi} with cluster size {size}.
        slots:
          name: requestBody.name
          nifi: requestBody.cfmNifiVersion
          size: requestBody.clusterSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dfx/api/rpc-v1/deployments/create-reporting-task'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a reporting task in a deployment
      effect: write
      questions:
      - How do I add a NiFi reporting task to a deployment from a definition file?
      - Can I attach a reporting task to a deployment?
      instructions:
      - text: Create a reporting task from file {file} in deployment {deployment}.
        slots:
          file: requestBody.filePath
          deployment: requestBody.deploymentCrn
      - text: Add the reporting task defined in {file} in environment {environment}.
        slots:
          file: requestBody.filePath
          environment: requestBody.environmentCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dfx/api/rpc-v1/deployments/delete-reporting-task'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a reporting task
      effect: destructive
      questions:
      - Can I remove a reporting task from a deployment?
      - How do I get rid of a NiFi reporting task I no longer need?
      instructions:
      - text: Delete reporting task {task} from deployment {deployment}.
        slots:
          task: requestBody.reportingTaskCrn
          deployment: requestBody.deploymentCrn
      - text: Remove reporting task {task} in environment {environment}.
        slots:
          task: requestBody.reportingTaskCrn
          environment: requestBody.environmentCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dfx/api/rpc-v1/deployments/export-deployment'].post
  update:
    x-apievangelist-phrasing:
      intent: Export a deployment's configuration
      effect: write
      questions:
      - How do I export a deployment's configuration to an archive I can import elsewhere?
      - Can I add a description to an exported deployment archive?
      instructions:
      - text: Export the configuration of deployment {deployment}.
        slots:
          deployment: requestBody.deploymentCrn
      - text: Export deployment {deployment} with archive description {description}.
        slots:
          deployment: requestBody.deploymentCrn
          description: requestBody.archiveDescription
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dfx/api/rpc-v1/deployments/get-deployment-configuration'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a deployment's configuration
      effect: read
      questions:
      - What scaling, inbound and parameter settings is my deployment running with?
      - Can I read back the full configuration of a deployment?
      instructions:
      - text: Show the configuration of deployment {deployment}.
        slots:
          deployment: requestBody.deploymentCrn
      - text: Get deployment {deployment}'s settings in environment {environment}.
        slots:
          deployment: requestBody.deploymentCrn
          environment: requestBody.environmentCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dfx/api/rpc-v1/deployments/get-deployment-configuration-metadata'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a deployment's configuration metadata
      effect: read
      questions:
      - Which configuration version is my deployment currently on?
      - Where do I find metadata about a deployment's configuration?
      instructions:
      - text: Get the configuration metadata for deployment {deployment}.
        slots:
          deployment: requestBody.deploymentCrn
      - text: Check the current configuration version of deployment {deployment} in {environment}.
        slots:
          deployment: requestBody.deploymentCrn
          environment: requestBody.environmentCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dfx/api/rpc-v1/deployments/get-deployment-request-details'].post
  update:
    x-apievangelist-phrasing:
      intent: Get and register a deployment request
      effect: write
      questions:
      - How do I register a deployment request before creating the deployment?
      - What details does a new deployment request return?
      instructions:
      - text: Get the details of deployment request {request} and register it.
        slots:
          request: requestBody.deploymentRequestCrn
      - text: Register deployment request {request} in environment {environment}.
        slots:
          request: requestBody.deploymentRequestCrn
          environment: requestBody.environmentCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dfx/api/rpc-v1/deployments/import-deployment'].post
  update:
    x-apievangelist-phrasing:
      intent: Import a deployment from an archive
      effect: write
      questions:
      - Can I recreate a deployment from a previously exported archive?
      - How do I import a whole deployment configuration into another environment?
      instructions:
      - text: Import deployment configuration from archive {archive} for deployment request {request}.
        slots:
          archive: requestBody.archiveName
          request: requestBody.deploymentRequestCrn
      - text: Import archive {archive} as a new deployment in environment {environment}.
        slots:
          archive: requestBody.archiveName
          environment: requestBody.environmentCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dfx/api/rpc-v1/deployments/list-deployment-archives'].post
  update:
    x-apievangelist-phrasing:
      intent: List exported deployment archives
      effect: read
      questions:
      - Which deployment exports are available to import?
      - Can I search exported deployment archives by name?
      instructions:
      - text: List exported deployment archives in environment {environment}.
        slots:
          environment: requestBody.environmentCrn
      - text: Find exported deployment archives matching {term}.
        slots:
          term: requestBody.searchTerm
      method: generated
      generated: '2026-10-01'


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