# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for CDP Control Plane Data Recovery Service Drscp API
  version: 1.0.0
extends: openapi/cloudera-drscp-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: 9
- target: $.paths['/api/v1/drscp/createBackup'].post
  update:
    x-apievangelist-phrasing:
      intent: Back up the control plane
      effect: write
      questions:
      - How do I take an on-demand backup of my CDP control plane?
      - Does a control plane backup include the embedded database and Kubernetes objects?
      instructions:
      - text: Create a control plane backup now.
      - text: Back up control plane item {itemName} as {backupName}.
        slots:
          itemName: requestBody.itemName
          backupName: requestBody.backupName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/drscp/restoreBackup'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore the control plane from a backup
      effect: write
      questions:
      - How do I rebuild my control plane from an existing backup?
      - What do I need to start a control plane restore?
      instructions:
      - text: Restore the control plane from backup {backupCrn}.
        slots:
          backupCrn: requestBody.backupCrn
      - text: Recreate the control plane using backup {backupCrn}.
        slots:
          backupCrn: requestBody.backupCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/drscp/deleteBackup'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a control plane backup
      effect: destructive
      questions:
      - Can I delete an old control plane backup?
      - Does deleting a control plane backup return right away?
      instructions:
      - text: Delete control plane backup {backupCrn}.
        slots:
          backupCrn: requestBody.backupCrn
      - text: Permanently remove backup {backupCrn}.
        slots:
          backupCrn: requestBody.backupCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/drscp/describeBackup'].post
  update:
    x-apievangelist-phrasing:
      intent: Describe a control plane backup
      effect: read
      questions:
      - What state is a particular control plane backup in?
      - Can I see what a control plane backup contains?
      instructions:
      - text: Describe control plane backup {backupCrn}.
        slots:
          backupCrn: requestBody.backupCrn
      - text: Show the status of backup {backupCrn}.
        slots:
          backupCrn: requestBody.backupCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/drscp/describeRestore'].post
  update:
    x-apievangelist-phrasing:
      intent: Describe a control plane restore
      effect: read
      questions:
      - Has my control plane restore finished?
      - What details are reported for a restore operation?
      instructions:
      - text: Describe control plane restore {restoreCrn}.
        slots:
          restoreCrn: requestBody.restoreCrn
      - text: Show progress of restore job {restoreCrn}.
        slots:
          restoreCrn: requestBody.restoreCrn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/drscp/listBackupEntities'].post
  update:
    x-apievangelist-phrasing:
      intent: List what can be backed up
      effect: read
      questions:
      - Which control plane namespaces are eligible for backup?
      - Is the vault namespace included in backup entities?
      instructions:
      - text: List the potential backup entities for the control plane.
      - text: Show which namespaces I can include in a control plane backup.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/drscp/listBackups'].post
  update:
    x-apievangelist-phrasing:
      intent: List control plane backups
      effect: read
      questions:
      - What control plane backups exist?
      - Can I filter control plane backups by job state or name?
      instructions:
      - text: List all control plane backups.
      - text: List backups named {backupName} in states {jobStates}.
        slots:
          backupName: requestBody.backupName
          jobStates: requestBody.jobStates
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/drscp/listRestores'].post
  update:
    x-apievangelist-phrasing:
      intent: List control plane restores
      effect: read
      questions:
      - Which control plane restores have been run?
      - Can I list only the restores made from one backup?
      instructions:
      - text: List all control plane restores.
      - text: List restores from backup {backupCrn} in states {jobStates}.
        slots:
          backupCrn: requestBody.backupCrn
          jobStates: requestBody.jobStates
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/drscp/getLogs'].post
  update:
    x-apievangelist-phrasing:
      intent: Get logs for a backup or restore job
      effect: read
      questions:
      - Where can I read the logs of a failed control plane backup or restore?
      - Can I fetch job logs using the job's CRN?
      instructions:
      - text: Get the job logs for {crn}.
        slots:
          crn: requestBody.crn
      - text: Show backup or restore logs for job {crn}.
        slots:
          crn: requestBody.crn
      method: generated
      generated: '2026-10-01'