# 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 Service Df API version: 1.0.0 extends: openapi/cloudera-df-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: 66 - target: $.paths['/api/v1/df/addReadyflow'].post update: x-apievangelist-phrasing: intent: Add a ReadyFlow to my account effect: write questions: - Can I add a prebuilt ReadyFlow from the gallery into my DataFlow account? - What do I need to add a ReadyFlow so my team can deploy it? instructions: - text: Add ReadyFlow {readyflowCrn} to my account. slots: readyflowCrn: requestBody.readyflowCrn - text: Make the gallery ReadyFlow {readyflowCrn} available in our DataFlow account. slots: readyflowCrn: requestBody.readyflowCrn method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/assignToCollection'].post update: x-apievangelist-phrasing: intent: Assign a flow definition to a collection effect: write questions: - Can I group an existing flow definition into a catalog collection? - Which call puts a flow definition I already imported into a collection? instructions: - text: Assign flow {flowCrn} to collection {catalogCollectionCrn}. slots: flowCrn: requestBody.flowCrn catalogCollectionCrn: requestBody.catalogCollectionCrn - text: Move flow definition {flowCrn} into the {catalogCollectionCrn} catalog collection. slots: flowCrn: requestBody.flowCrn catalogCollectionCrn: requestBody.catalogCollectionCrn method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/cancelDeleteProject'].post update: x-apievangelist-phrasing: intent: Cancel a pending project deletion effect: write questions: - Can I stop a DataFlow project from being deleted after I requested it? - What revision do I need to cancel a project's deletion? instructions: - text: Cancel the deletion of project {projectCrn} at revision {projectRevision}. slots: projectCrn: requestBody.projectCrn projectRevision: requestBody.projectRevision - text: Stop deleting project {projectCrn}, revision {projectRevision}. slots: projectCrn: requestBody.projectCrn projectRevision: requestBody.projectRevision method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/createCollection'].post update: x-apievangelist-phrasing: intent: Create a catalog collection effect: write questions: - How do I create a new collection in the DataFlow catalog? - Can I add a description when creating a catalog collection? instructions: - text: Create a catalog collection named {name}. slots: name: requestBody.name - text: Create collection {name} described as {description}. slots: name: requestBody.name description: requestBody.description method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/createFlowVersionTag'].post update: x-apievangelist-phrasing: intent: Tag a flow version effect: write questions: - Can I label a specific flow version with a colored tag? - Is there a way to mark one flow definition version with a named tag? instructions: - text: Tag flow version {flowVersionCrn} as {tagName}. slots: flowVersionCrn: requestBody.flowVersionCrn tagName: requestBody.tagName - text: Add a {tagColor} tag {tagName} to flow version {flowVersionCrn}. slots: tagColor: requestBody.tagColor tagName: requestBody.tagName flowVersionCrn: requestBody.flowVersionCrn method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/createProject'].post update: x-apievangelist-phrasing: intent: Create a DataFlow project effect: write questions: - How do I create a project inside a DataFlow service? - Which service does a new DataFlow project need to belong to? instructions: - text: Create project {name} in service {serviceCrn}. slots: name: requestBody.name serviceCrn: requestBody.serviceCrn - text: Create a project called {name} on service {serviceCrn} with description {description}. slots: name: requestBody.name serviceCrn: requestBody.serviceCrn description: requestBody.description method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/deleteAddedReadyflow'].post update: x-apievangelist-phrasing: intent: Remove an added ReadyFlow from my account effect: destructive questions: - Can I remove a ReadyFlow I previously added to my account? - Is there a way to undo adding a ReadyFlow to our DataFlow account? instructions: - text: Delete added ReadyFlow {addedReadyflowCrn}. slots: addedReadyflowCrn: requestBody.addedReadyflowCrn - text: Remove the ReadyFlow {addedReadyflowCrn} we added from our account. slots: addedReadyflowCrn: requestBody.addedReadyflowCrn method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/deleteCollection'].post update: x-apievangelist-phrasing: intent: Delete an empty catalog collection effect: destructive questions: - Can I delete a catalog collection that still has flows in it? - What's the way to get rid of an empty DataFlow catalog collection? instructions: - text: Delete catalog collection {catalogCollectionCrn}. slots: catalogCollectionCrn: requestBody.catalogCollectionCrn - text: Remove the empty collection {catalogCollectionCrn} from the catalog. slots: catalogCollectionCrn: requestBody.catalogCollectionCrn method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/deleteFlow'].post update: x-apievangelist-phrasing: intent: Delete a flow definition effect: destructive questions: - How do I delete a flow definition from the DataFlow catalog? - Can I permanently remove a flow from the catalog? instructions: - text: Delete flow {flowCrn}. slots: flowCrn: requestBody.flowCrn - text: Remove flow definition {flowCrn} from the catalog. slots: flowCrn: requestBody.flowCrn method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/deleteFlowVersionTag'].post update: x-apievangelist-phrasing: intent: Remove a tag from a flow version effect: destructive questions: - Can I remove a tag I put on a flow version? - What do I need to untag a flow definition version? instructions: - text: Remove tag {tagName} from flow version {flowVersionCrn}. slots: tagName: requestBody.tagName flowVersionCrn: requestBody.flowVersionCrn - text: Delete the {tagName} tag on flow version {flowVersionCrn}. slots: tagName: requestBody.tagName flowVersionCrn: requestBody.flowVersionCrn method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/deleteProject'].post update: x-apievangelist-phrasing: intent: Delete a DataFlow project effect: destructive questions: - Can I delete a DataFlow project I no longer use? - Does deleting a DataFlow project require its current revision number? instructions: - text: Delete project {projectCrn} at revision {projectRevision}. slots: projectCrn: requestBody.projectCrn projectRevision: requestBody.projectRevision - text: Remove DataFlow project {projectCrn} (revision {projectRevision}). slots: projectCrn: requestBody.projectCrn projectRevision: requestBody.projectRevision method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/describeAddedReadyflow'].post update: x-apievangelist-phrasing: intent: Get details of a ReadyFlow I added effect: read questions: - Can I see the details of a ReadyFlow as it was added to my account? - What does our added copy of a ReadyFlow contain? instructions: - text: Show details for added ReadyFlow {addedReadyflowCrn}. slots: addedReadyflowCrn: requestBody.addedReadyflowCrn - text: Describe the ReadyFlow {addedReadyflowCrn} in our account. slots: addedReadyflowCrn: requestBody.addedReadyflowCrn method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/describeCollection'].post update: x-apievangelist-phrasing: intent: Get a catalog collection's details effect: read questions: - What's in a specific DataFlow catalog collection? - Can I look up one catalog collection by its CRN? instructions: - text: Describe catalog collection {catalogCollectionCrn}. slots: catalogCollectionCrn: requestBody.catalogCollectionCrn - text: Show me the details of collection {catalogCollectionCrn}. slots: catalogCollectionCrn: requestBody.catalogCollectionCrn method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/describeDeployment'].post update: x-apievangelist-phrasing: intent: Get a flow deployment's details effect: read questions: - What's the current state of one of my DataFlow deployments? - Can I see the configuration of a single deployment? instructions: - text: Describe deployment {deploymentCrn}. slots: deploymentCrn: requestBody.deploymentCrn - text: Show me deployment {deploymentCrn}'s details. slots: deploymentCrn: requestBody.deploymentCrn method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/describeDeploymentEventDetail'].post update: x-apievangelist-phrasing: intent: Get details of a deployment event effect: read questions: - Can I see the full details of one event from a deployment's history? - What extra detail is recorded for a specific deployment event? instructions: - text: Show event {eventCrn} for deployment {deploymentCrn}. slots: eventCrn: requestBody.eventCrn deploymentCrn: requestBody.deploymentCrn - text: Get detail on deployment event {eventCrn} in {deploymentCrn}. slots: eventCrn: requestBody.eventCrn deploymentCrn: requestBody.deploymentCrn method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/describeFlow'].post update: x-apievangelist-phrasing: intent: Get a flow definition's details effect: read questions: - What details does the catalog hold for one flow definition? - Can I look up a flow definition by its CRN? instructions: - text: Describe flow {flowCrn}. slots: flowCrn: requestBody.flowCrn - text: Show catalog details for flow definition {flowCrn}. slots: flowCrn: requestBody.flowCrn method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/describeFlowEventDetailInDeployment'].post update: x-apievangelist-phrasing: intent: Get detail of a deployed flow's event effect: read questions: - Can I drill into one event for a specific flow running in a deployment? - What detail is available for a flow-level event in a deployment? instructions: - text: Show event {eventCrn} for flow {deployedFlowCrn} in deployment {deploymentCrn}. slots: eventCrn: requestBody.eventCrn deployedFlowCrn: requestBody.deployedFlowCrn deploymentCrn: requestBody.deploymentCrn - text: Get detail on flow event {eventCrn} of deployed flow {deployedFlowCrn} in {deploymentCrn}. slots: eventCrn: requestBody.eventCrn deployedFlowCrn: requestBody.deployedFlowCrn deploymentCrn: requestBody.deploymentCrn method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/describeFlowInDeployment'].post update: x-apievangelist-phrasing: intent: Describe a flow running in a deployment effect: read questions: - What does a single deployed flow look like inside a deployment? - Can I check the configuration of one flow in a multi-flow deployment? instructions: - text: Describe flow {deployedFlowCrn} in deployment {deploymentCrn}. slots: deployedFlowCrn: requestBody.deployedFlowCrn deploymentCrn: requestBody.deploymentCrn - text: Show me deployed flow {deployedFlowCrn} within {deploymentCrn}. slots: deployedFlowCrn: requestBody.deployedFlowCrn deploymentCrn: requestBody.deploymentCrn method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/describeProject'].post update: x-apievangelist-phrasing: intent: Get a DataFlow project's details effect: read questions: - What are the details of one DataFlow project? - Can I look up a single project by its CRN? instructions: - text: Describe project {projectCrn}. slots: projectCrn: requestBody.projectCrn - text: Show details for DataFlow project {projectCrn}. slots: projectCrn: requestBody.projectCrn method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/describeReadyflow'].post update: x-apievangelist-phrasing: intent: Get a ReadyFlow's details from the gallery effect: read questions: - What does a ReadyFlow in the gallery do before I add it? - Can I see the details of a ReadyFlow I haven't added yet? instructions: - text: Describe ReadyFlow {readyflowCrn}. slots: readyflowCrn: requestBody.readyflowCrn - text: Show gallery details for ReadyFlow {readyflowCrn}. slots: readyflowCrn: requestBody.readyflowCrn method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/describeService'].post update: x-apievangelist-phrasing: intent: Get a DataFlow service's details effect: read questions: - What's the status of the DataFlow service in my environment? - Can I see how a DataFlow service is configured? instructions: - text: Describe DataFlow service {serviceCrn}. slots: serviceCrn: requestBody.serviceCrn - text: Show me the details of service {serviceCrn}. slots: serviceCrn: requestBody.serviceCrn method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/describeServiceEventDetail'].post update: x-apievangelist-phrasing: intent: Get details of a service event effect: read questions: - Can I see the full detail of one event in a DataFlow service's history? - What extra information is recorded for a service-level event? instructions: - text: Show event {eventCrn} for service {serviceCrn}. slots: eventCrn: requestBody.eventCrn serviceCrn: requestBody.serviceCrn - text: Get detail on service event {eventCrn} in {serviceCrn}. slots: eventCrn: requestBody.eventCrn serviceCrn: requestBody.serviceCrn method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/disableService'].post update: x-apievangelist-phrasing: intent: Disable a DataFlow service effect: destructive questions: - How do I disable DataFlow in an environment? - Can I terminate running deployments when disabling the service? instructions: - text: Disable DataFlow service {serviceCrn}. slots: serviceCrn: requestBody.serviceCrn - text: Disable service {serviceCrn} with terminate deployments set to {terminateDeployments}. slots: serviceCrn: requestBody.serviceCrn terminateDeployments: requestBody.terminateDeployments method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/enableService'].post update: x-apievangelist-phrasing: intent: Enable DataFlow in a CDP environment effect: write questions: - How do I turn on DataFlow for a CDP environment? - Can I set the minimum and maximum Kubernetes node counts when enabling DataFlow? - Is a private cluster supported when enabling the DataFlow service? instructions: - text: Enable DataFlow in environment {environmentCrn} with {minK8sNodeCount} to {maxK8sNodeCount} nodes, public load balancer {usePublicLoadBalancer}. slots: environmentCrn: requestBody.environmentCrn minK8sNodeCount: requestBody.minK8sNodeCount maxK8sNodeCount: requestBody.maxK8sNodeCount usePublicLoadBalancer: requestBody.usePublicLoadBalancer - text: Enable DataFlow on {environmentCrn} as a private cluster {privateCluster}, nodes {minK8sNodeCount}-{maxK8sNodeCount}, public LB {usePublicLoadBalancer}. slots: environmentCrn: requestBody.environmentCrn privateCluster: requestBody.privateCluster minK8sNodeCount: requestBody.minK8sNodeCount maxK8sNodeCount: requestBody.maxK8sNodeCount usePublicLoadBalancer: requestBody.usePublicLoadBalancer method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/getFlowVersion'].post update: x-apievangelist-phrasing: intent: Download a flow definition version effect: read questions: - Can I download the flow definition for a specific version? - Where do I get the exported flow definition for a flow version? instructions: - text: Download flow version {flowVersionCrn}. slots: flowVersionCrn: requestBody.flowVersionCrn - text: Export the flow definition for version {flowVersionCrn}. slots: flowVersionCrn: requestBody.flowVersionCrn method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/getKubeconfig'].post update: x-apievangelist-phrasing: intent: Get the kubeconfig for a DataFlow service effect: read questions: - Can I get kubectl access config for my DataFlow service cluster? - Where do I download the Kubernetes config for a DataFlow environment? instructions: - text: Get the kubeconfig for DataFlow service {serviceCrn}. slots: serviceCrn: requestBody.serviceCrn - text: Download kubeconfig for service {serviceCrn}. slots: serviceCrn: requestBody.serviceCrn method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/grantUserKubernetesAccess'].post update: x-apievangelist-phrasing: intent: Grant a user access to the DataFlow cluster effect: write questions: - How do I give a cloud user access to the Kubernetes cluster behind DataFlow? - Can I grant a remote user access to a DataFlow service's cluster? instructions: - text: Grant cloud user {cloudUserId} access to the cluster of service {serviceCrn}. slots: cloudUserId: requestBody.cloudUserId serviceCrn: requestBody.serviceCrn - text: Give {cloudUserId} Kubernetes access on DataFlow service {serviceCrn}. slots: cloudUserId: requestBody.cloudUserId serviceCrn: requestBody.serviceCrn method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/importFlowDefinition'].post update: x-apievangelist-phrasing: intent: Import a new flow definition effect: write questions: - How do I import a flow definition file as a new flow in the catalog? - Can I place a newly imported flow definition straight into a collection? instructions: - text: Import {file} as a new flow named {name}. slots: file: requestBody.file name: requestBody.name - text: Import flow definition {file} named {name} into collection {collectionCrn}. slots: file: requestBody.file name: requestBody.name collectionCrn: requestBody.collectionCrn method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/importFlowDefinitionVersion'].post update: x-apievangelist-phrasing: intent: Import a new version of an existing flow effect: write questions: - Can I upload a new version of a flow that's already in the catalog? - Is it possible to add version comments when importing an updated flow definition? instructions: - text: Import {file} as a new version of flow {flowCrn}. slots: file: requestBody.file flowCrn: requestBody.flowCrn - text: Add a new version to flow {flowCrn} from {file} with comments {comments}. slots: flowCrn: requestBody.flowCrn file: requestBody.file comments: requestBody.comments method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/initiateDeployment'].post update: x-apievangelist-phrasing: intent: Start creating a deployment (internal) effect: write questions: - What is the internal call that starts creating a deployment from a flow version? - Can I kick off a deployment creation for a flow version on a service directly? instructions: - text: Initiate a deployment of flow version {flowVersionCrn} on service {serviceCrn}. slots: flowVersionCrn: requestBody.flowVersionCrn serviceCrn: requestBody.serviceCrn - text: Start internal deployment creation for {flowVersionCrn} on {serviceCrn}. slots: flowVersionCrn: requestBody.flowVersionCrn serviceCrn: requestBody.serviceCrn method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/initiateFlowInDeployment'].post update: x-apievangelist-phrasing: intent: Start adding a flow to a deployment (internal) effect: write questions: - Can I begin adding another flow version to an existing deployment? - What internal call starts creating a flow inside a deployment? instructions: - text: Initiate flow {flowVersionCrn} in deployment {deploymentCrn} on service {serviceCrn}. slots: flowVersionCrn: requestBody.flowVersionCrn deploymentCrn: requestBody.deploymentCrn serviceCrn: requestBody.serviceCrn - text: Start adding flow version {flowVersionCrn} to deployment {deploymentCrn} on {serviceCrn}. slots: flowVersionCrn: requestBody.flowVersionCrn deploymentCrn: requestBody.deploymentCrn serviceCrn: requestBody.serviceCrn method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/listCollections'].post update: x-apievangelist-phrasing: intent: List catalog collections effect: read questions: - What collections exist in my DataFlow catalog? - Can I search catalog collections by name? instructions: - text: List my catalog collections. - text: Find catalog collections matching {searchTerm}. slots: searchTerm: requestBody.searchTerm method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/listDeployableServicesForNewDeployments'].post update: x-apievangelist-phrasing: intent: List services I can deploy flows to effect: read questions: - Which DataFlow services am I allowed to deploy a new flow to? - Where can a DataFlow Admin create new deployments? instructions: - text: List services available for new deployments. - text: Show the services I can deploy to as a DataFlow Admin. method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/listDeploymentActiveAlerts'].post update: x-apievangelist-phrasing: intent: List active alerts for a deployment effect: read questions: - Are there any active alerts on my deployment right now? - Can I sort a deployment's active alerts? instructions: - text: List active alerts for deployment {deploymentCrn}. slots: deploymentCrn: requestBody.deploymentCrn - text: Show current alerts on {deploymentCrn} sorted by {sort}. slots: deploymentCrn: requestBody.deploymentCrn sort: requestBody.sort method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/listDeploymentEvents'].post update: x-apievangelist-phrasing: intent: List a deployment's event history effect: read questions: - What happened to my deployment recently? - Can I filter a deployment's event history from a certain timestamp? instructions: - text: List events for deployment {deploymentCrn}. slots: deploymentCrn: requestBody.deploymentCrn - text: Show event history for {deploymentCrn} since {timestampFrom}. slots: deploymentCrn: requestBody.deploymentCrn timestampFrom: requestBody.timestampFrom method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/listDeploymentKPIs'].post update: x-apievangelist-phrasing: intent: Get KPIs for a deployment effect: read questions: - What KPIs is my deployment hitting over the last period? - Can I choose the time period for deployment KPI metrics? instructions: - text: List KPIs for deployment {deploymentCrn} over {metricsTimePeriod}. slots: deploymentCrn: requestBody.deploymentCrn metricsTimePeriod: requestBody.metricsTimePeriod - text: Show KPI metrics of {deploymentCrn} for {metricsTimePeriod}. slots: deploymentCrn: requestBody.deploymentCrn metricsTimePeriod: requestBody.metricsTimePeriod method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/listDeploymentSystemMetrics'].post update: x-apievangelist-phrasing: intent: Get system metrics for a deployment effect: read questions: - What system-level metrics does a deployment report over time? - Can I see a deployment's system metrics for a chosen time window? instructions: - text: Get system metrics for deployment {deploymentCrn} over {metricsTimePeriod}. slots: deploymentCrn: requestBody.deploymentCrn metricsTimePeriod: requestBody.metricsTimePeriod - text: Show {deploymentCrn} system resource metrics for {metricsTimePeriod}. slots: deploymentCrn: requestBody.deploymentCrn metricsTimePeriod: requestBody.metricsTimePeriod method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/listDeployments'].post update: x-apievangelist-phrasing: intent: List flow deployments effect: read questions: - Which flow deployments are running across my DataFlow services? - Can I search or filter my deployments? instructions: - text: List my deployments. - text: Find deployments matching {searchTerm}. slots: searchTerm: requestBody.searchTerm method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/listDiagnostics'].post update: x-apievangelist-phrasing: intent: List diagnostic bundle requests effect: read questions: - What diagnostic bundles have been requested for my DataFlow service? - Can I check the status of a diagnostics collection by its UUID? instructions: - text: List diagnostics requests for service {dfServiceCrn}. slots: dfServiceCrn: requestBody.dfServiceCrn - text: Show diagnostics {uuids} for service {dfServiceCrn}. slots: uuids: requestBody.uuids dfServiceCrn: requestBody.dfServiceCrn method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/listFilterOptions'].post update: x-apievangelist-phrasing: intent: List available filter options effect: read questions: - What values are available for a given filter type in DataFlow listings? - Can I fetch the allowed values for a filter type before filtering a list? instructions: - text: List filter options for filter type {filterType}. slots: filterType: requestBody.filterType - text: Show the values available for the {filterType} filter. slots: filterType: requestBody.filterType method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/listFlowActiveAlertsInDeployment'].post update: x-apievangelist-phrasing: intent: List active alerts for a deployed flow effect: read questions: - Does a specific flow in my deployment have any active alerts? - Can I see alerts for just one flow rather than the whole deployment? instructions: - text: List active alerts for flow {deployedFlowCrn} in deployment {deploymentCrn}. slots: deployedFlowCrn: requestBody.deployedFlowCrn deploymentCrn: requestBody.deploymentCrn - text: Show current alerts on deployed flow {deployedFlowCrn} of {deploymentCrn}. slots: deployedFlowCrn: requestBody.deployedFlowCrn deploymentCrn: requestBody.deploymentCrn method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/listFlowDefinitionVersions'].post update: x-apievangelist-phrasing: intent: List versions of a flow definition effect: read questions: - What versions exist for a flow definition? - Can I search a flow's versions by a term? instructions: - text: List versions of flow {flowCrn}. slots: flowCrn: requestBody.flowCrn - text: Find versions of flow {flowCrn} matching {searchTerm}. slots: flowCrn: requestBody.flowCrn searchTerm: requestBody.searchTerm method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/listFlowDefinitions'].post update: x-apievangelist-phrasing: intent: List flow definitions in the catalog effect: read questions: - What flow definitions are in my DataFlow catalog? - Can I list only the flow definitions within one collection? instructions: - text: List flow definitions. - text: List flow definitions in collection {collectionCrn}. slots: collectionCrn: requestBody.collectionCrn method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/listFlowEventsInDeployment'].post update: x-apievangelist-phrasing: intent: List event history for a deployed flow effect: read questions: - What events has one flow in my deployment logged? - Can I filter a deployed flow's events since a timestamp? instructions: - text: List events for flow {deployedFlowCrn} in deployment {deploymentCrn}. slots: deployedFlowCrn: requestBody.deployedFlowCrn deploymentCrn: requestBody.deploymentCrn - text: Show events of deployed flow {deployedFlowCrn} in {deploymentCrn} since {timestampFrom}. slots: deployedFlowCrn: requestBody.deployedFlowCrn deploymentCrn: requestBody.deploymentCrn timestampFrom: requestBody.timestampFrom method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/listFlowKpisInDeployment'].post update: x-apievangelist-phrasing: intent: Get KPI metrics for a deployed flow effect: read questions: - How is a single flow performing within its deployment? - Can I chart KPIs for one deployed flow over a time period? instructions: - text: Get KPIs for flow {deployedFlowCrn} in deployment {deploymentCrn} over {metricsTimePeriod}. slots: deployedFlowCrn: requestBody.deployedFlowCrn deploymentCrn: requestBody.deploymentCrn metricsTimePeriod: requestBody.metricsTimePeriod - text: Show KPI charts for deployed flow {deployedFlowCrn} in {deploymentCrn} for {metricsTimePeriod}. slots: deployedFlowCrn: requestBody.deployedFlowCrn deploymentCrn: requestBody.deploymentCrn metricsTimePeriod: requestBody.metricsTimePeriod method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/listFlowVersionTags'].post update: x-apievangelist-phrasing: intent: List tags on a flow version effect: read questions: - What tags are attached to a flow version? - Can I check whether a flow version has been tagged? instructions: - text: List tags on flow version {flowVersionCrn}. slots: flowVersionCrn: requestBody.flowVersionCrn - text: Show the tags for {flowVersionCrn}. slots: flowVersionCrn: requestBody.flowVersionCrn method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/listFlowsInDeployment'].post update: x-apievangelist-phrasing: intent: List flows in a deployment effect: read questions: - Which flows are running inside a particular deployment? - Can I search the flows within one deployment? instructions: - text: List flows in deployment {deploymentCrn}. slots: deploymentCrn: requestBody.deploymentCrn - text: Find flows in {deploymentCrn} matching {searchTerm}. slots: deploymentCrn: requestBody.deploymentCrn searchTerm: requestBody.searchTerm method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/listNotifications'].post update: x-apievangelist-phrasing: intent: List DataFlow notifications effect: read questions: - What DataFlow notifications have arrived since a given time? - Can I fetch only notifications newer than a timestamp? instructions: - text: List notifications since {timestampAfter}. slots: timestampAfter: requestBody.timestampAfter - text: Show DataFlow notifications after {timestampAfter}. slots: timestampAfter: requestBody.timestampAfter method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/listProjectFilterOptions'].post update: x-apievangelist-phrasing: intent: List filter options for projects effect: read questions: - Which filter values can I use when listing projects? - Can I get the allowed project filter values for a filter type? instructions: - text: List project filter options for {filterType}. slots: filterType: requestBody.filterType - text: Show values I can use for the {filterType} project filter. slots: filterType: requestBody.filterType method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/listProjects'].post update: x-apievangelist-phrasing: intent: List DataFlow projects effect: read questions: - What projects exist across my DataFlow services? - Can I filter and sort the list of projects? instructions: - text: List my DataFlow projects. - text: List projects filtered by {filters}. slots: filters: requestBody.filters method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/listReadyflows'].post update: x-apievangelist-phrasing: intent: List available ReadyFlows effect: read questions: - What ReadyFlows are available in the gallery? - Can I search ReadyFlows by keyword? instructions: - text: List ReadyFlows. - text: Find ReadyFlows matching {searchTerm}. slots: searchTerm: requestBody.searchTerm method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/listServiceActiveAlerts'].post update: x-apievangelist-phrasing: intent: List active alerts for a service effect: read questions: - Is my DataFlow service raising any alerts right now? - Can I sort the active alerts on a DataFlow service? instructions: - text: List active alerts for service {serviceCrn}. slots: serviceCrn: requestBody.serviceCrn - text: Show current alerts on DataFlow service {serviceCrn}. slots: serviceCrn: requestBody.serviceCrn method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/listServiceEvents'].post update: x-apievangelist-phrasing: intent: List a service's event history effect: read questions: - What events has my DataFlow service recorded? - Can I filter service events from a start timestamp? instructions: - text: List events for service {serviceCrn}. slots: serviceCrn: requestBody.serviceCrn - text: Show events for service {serviceCrn} since {timestampFrom}. slots: serviceCrn: requestBody.serviceCrn timestampFrom: requestBody.timestampFrom method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/listServiceSystemMetrics'].post update: x-apievangelist-phrasing: intent: Get system metrics for a service effect: read questions: - What system metrics does my DataFlow service report? - Can I view a service's system metrics for a chosen time period? instructions: - text: Get system metrics for service {serviceCrn} over {metricsTimePeriod}. slots: serviceCrn: requestBody.serviceCrn metricsTimePeriod: requestBody.metricsTimePeriod - text: Show service {serviceCrn} system metrics for {metricsTimePeriod}. slots: serviceCrn: requestBody.serviceCrn metricsTimePeriod: requestBody.metricsTimePeriod method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/listServices'].post update: x-apievangelist-phrasing: intent: List DataFlow services effect: read questions: - Which environments have DataFlow services enabled? - Can I search my DataFlow services by name? instructions: - text: List my DataFlow services. - text: Find DataFlow services matching {searchTerm}. slots: searchTerm: requestBody.searchTerm method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/listUserKubernetesAccess'].post update: x-apievangelist-phrasing: intent: List users with access to a service's cluster effect: read questions: - Who has Kubernetes access to my DataFlow service's cluster? - Can I audit which remote users can reach a DataFlow cluster? instructions: - text: List users with cluster access on service {serviceCrn}. slots: serviceCrn: requestBody.serviceCrn - text: Show who can access the Kubernetes cluster of {serviceCrn}. slots: serviceCrn: requestBody.serviceCrn method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/renewCertificates'].post update: x-apievangelist-phrasing: intent: Renew workload UI certificates effect: write questions: - How do I renew the workload UI certificates for a DataFlow service? - Can I refresh expiring UI certificates on a service? instructions: - text: Renew UI certificates for service {serviceCrn}. slots: serviceCrn: requestBody.serviceCrn - text: Renew workload certificates on DataFlow service {serviceCrn}. slots: serviceCrn: requestBody.serviceCrn method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/resetService'].post update: x-apievangelist-phrasing: intent: Reset a non-enabled DataFlow service effect: destructive questions: - Can I reset references to a DataFlow service that isn't enabled? - Does resetting a service clean up its cloud resources? instructions: - text: Reset DataFlow service {serviceCrn}. slots: serviceCrn: requestBody.serviceCrn - text: Clear all references to the non-enabled service {serviceCrn}. slots: serviceCrn: requestBody.serviceCrn method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/revokeUserKubernetesAccess'].post update: x-apievangelist-phrasing: intent: Revoke a user's access to the cluster effect: destructive questions: - Is there a way to remove a remote user's access to a DataFlow cluster? - Can I revoke Kubernetes access I granted to a cloud user? instructions: - text: Revoke cluster access for {cloudUserId} on service {serviceCrn}. slots: cloudUserId: requestBody.cloudUserId serviceCrn: requestBody.serviceCrn - text: Remove {cloudUserId}'s Kubernetes access to {serviceCrn}. slots: cloudUserId: requestBody.cloudUserId serviceCrn: requestBody.serviceCrn method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/rotatePassword'].post update: x-apievangelist-phrasing: intent: Rotate the database root password effect: write questions: - Can I rotate the database server root password for a DataFlow service? - What changes the DataFlow service's database root credentials? instructions: - text: Rotate the database root password for service {serviceCrn}. slots: serviceCrn: requestBody.serviceCrn - text: Rotate DB root password on {serviceCrn}. slots: serviceCrn: requestBody.serviceCrn method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/startGetDiagnosticsCollection'].post update: x-apievangelist-phrasing: intent: Start a diagnostics bundle collection effect: write questions: - How do I collect a diagnostics bundle for a support case? - Can I include NiFi diagnostics in a DataFlow diagnostic bundle? - Can I limit a diagnostics bundle to a time window? instructions: - text: Collect diagnostics for service {dfServiceCrn} to {destination} with description {description}. slots: dfServiceCrn: requestBody.dfServiceCrn destination: requestBody.destination description: requestBody.description - text: Start a diagnostics bundle for {dfServiceCrn} to {destination} for case {caseNumber}, described as {description}. slots: dfServiceCrn: requestBody.dfServiceCrn destination: requestBody.destination caseNumber: requestBody.caseNumber description: requestBody.description method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/updateCollection'].post update: x-apievangelist-phrasing: intent: Update a catalog collection effect: write questions: - Can I rename a catalog collection? - What's the way to change a collection's description? instructions: - text: Rename collection {catalogCollectionCrn} to {name}. slots: catalogCollectionCrn: requestBody.catalogCollectionCrn name: requestBody.name - text: Set the description of collection {catalogCollectionCrn} to {description}. slots: catalogCollectionCrn: requestBody.catalogCollectionCrn description: requestBody.description method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/updateNodeImages'].post update: x-apievangelist-phrasing: intent: Update node images for a DataFlow service effect: write questions: - How do I update the cloud node images my DataFlow service runs on? - Will the service be unavailable while node images are updated? instructions: - text: Update node images for service {serviceCrn}. slots: serviceCrn: requestBody.serviceCrn - text: Move DataFlow service {serviceCrn} nodes to the latest image. slots: serviceCrn: requestBody.serviceCrn method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/updateProject'].post update: x-apievangelist-phrasing: intent: Update a DataFlow project effect: write questions: - Can I rename a DataFlow project? - What's needed to change a project's description? instructions: - text: Rename project {projectCrn} at revision {projectRevision} to {projectName}. slots: projectCrn: requestBody.projectCrn projectRevision: requestBody.projectRevision projectName: requestBody.projectName - text: Set project {projectCrn} (revision {projectRevision}) description to {projectDescription}. slots: projectCrn: requestBody.projectCrn projectRevision: requestBody.projectRevision projectDescription: requestBody.projectDescription method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/updateService'].post update: x-apievangelist-phrasing: intent: Change a DataFlow service's node scaling effect: write questions: - Can I change the min and max node count of an enabled DataFlow service? - Is it possible to update the authorized IP ranges for a service's Kubernetes API? instructions: - text: Scale service {serviceCrn} to between {minK8sNodeCount} and {maxK8sNodeCount} nodes. slots: serviceCrn: requestBody.serviceCrn minK8sNodeCount: requestBody.minK8sNodeCount maxK8sNodeCount: requestBody.maxK8sNodeCount - text: Update service {serviceCrn} with {minK8sNodeCount}-{maxK8sNodeCount} nodes and API IP ranges {kubeApiAuthorizedIpRanges}. slots: serviceCrn: requestBody.serviceCrn minK8sNodeCount: requestBody.minK8sNodeCount maxK8sNodeCount: requestBody.maxK8sNodeCount kubeApiAuthorizedIpRanges: requestBody.kubeApiAuthorizedIpRanges method: generated generated: '2026-10-01' - target: $.paths['/api/v1/df/upgradeService'].post update: x-apievangelist-phrasing: intent: Upgrade a DataFlow service effect: write questions: - How do I upgrade DataFlow to the latest version? - Can I also upgrade the NiFi version of deployments when upgrading the service? instructions: - text: Upgrade DataFlow service {serviceCrn}. slots: serviceCrn: requestBody.serviceCrn - text: Upgrade service {serviceCrn} with the deployments NiFi upgrade set to {upgradeDeploymentsNifiVersion}. slots: serviceCrn: requestBody.serviceCrn upgradeDeploymentsNifiVersion: requestBody.upgradeDeploymentsNifiVersion method: generated generated: '2026-10-01'