# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cohesity REST Recoveries API
  version: 1.0.0
extends: openapi/cohesity-recoveries-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['/data-protect/recoveries'].get
  update:
    x-apievangelist-phrasing:
      intent: List recoveries
      effect: read
      questions:
      - Which recoveries ran on the cluster in the last week, and did they succeed?
      - Can I filter recoveries by status, environment or recovery action?
      instructions:
      - text: List recoveries with status {status}.
        slots:
          status: query.status
      - text: Show recoveries started between {startTimeUsecs} and {endTimeUsecs}.
        slots:
          startTimeUsecs: query.startTimeUsecs
          endTimeUsecs: query.endTimeUsecs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data-protect/recoveries'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a recovery
      effect: write
      questions:
      - How do I start a recovery from a snapshot with the data-protect API?
      - What environment must be named when performing a recovery?
      instructions:
      - text: Start a {snapshotEnvironment} recovery named {name}.
        slots:
          snapshotEnvironment: requestBody.snapshotEnvironment
          name: requestBody.name
      - text: Perform recovery {name} for environment {snapshotEnvironment}.
        slots:
          name: requestBody.name
          snapshotEnvironment: requestBody.snapshotEnvironment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data-protect/recoveries/downloadFilesAndFoldersRecovery'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a download recovery for files
      effect: write
      questions:
      - Can I prepare specific files and folders from a backup for download as a recovery?
      - Which object and file paths does a download recovery need?
      instructions:
      - text: Create download recovery {name} for files {filesAndFolders} from object {object}.
        slots:
          name: requestBody.name
          filesAndFolders: requestBody.filesAndFolders
          object: requestBody.object
      - text: Package {filesAndFolders} from {object} for download as {name}.
        slots:
          filesAndFolders: requestBody.filesAndFolders
          object: requestBody.object
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data-protect/recoveries/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a recovery
      effect: read
      questions:
      - What is the status of a specific recovery?
      - Can I look up one recovery including its tenant details?
      instructions:
      - text: Get recovery {id}.
        slots:
          id: path.id
      - text: Check progress of recovery {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data-protect/recoveries/{id}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a recovery
      effect: destructive
      questions:
      - Can I stop a recovery that's still running?
      - What cancels an in-flight recovery by id?
      instructions:
      - text: Cancel recovery {id}.
        slots:
          id: path.id
      - text: Stop the running recovery {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data-protect/recoveries/{id}/debug-logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get debug logs for a recovery
      effect: read
      questions:
      - Where can I find debug logs to troubleshoot a failed recovery?
      - Can I download the logs for one recovery operation?
      instructions:
      - text: Get the debug logs for recovery {id}.
        slots:
          id: path.id
      - text: Download troubleshooting logs of recovery {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data-protect/recoveries/{id}/downloadFiles'].get
  update:
    x-apievangelist-phrasing:
      intent: Download files from a download recovery
      effect: read
      questions:
      - Once a download recovery is ready, how do I fetch the files?
      - Can I download a byte range of the recovered files?
      instructions:
      - text: Download the files from recovery {id}.
        slots:
          id: path.id
      - text: Download {length} bytes from offset {startOffset} of recovery {id}.
        slots:
          length: query.length
          startOffset: query.startOffset
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data-protect/recoveries/{id}/tearDown'].post
  update:
    x-apievangelist-phrasing:
      intent: Tear down a recovery
      effect: destructive
      questions:
      - Can I clean up mounts and clones left behind by a finished recovery?
      - What does tearing down a recovery remove?
      instructions:
      - text: Tear down recovery {id}.
        slots:
          id: path.id
      - text: Clean up the resources of recovery {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data-protect/snapshots/{snapshotsId}/downloadFile'].get
  update:
    x-apievangelist-phrasing:
      intent: Download an indexed file from a snapshot
      effect: read
      questions:
      - Can I download a single indexed file straight from a snapshot without a recovery task?
      - Is it possible to resume an indexed file download from an offset?
      instructions:
      - text: Download {filePath} from snapshot {snapshotsId}.
        slots:
          filePath: query.filePath
          snapshotsId: path.snapshotsId
      - text: Resume downloading {filePath} from snapshot {snapshotsId} at offset {startOffset}.
        slots:
          filePath: query.filePath
          snapshotsId: path.snapshotsId
          startOffset: query.startOffset
      method: generated
      generated: '2026-10-01'