# 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 Failover API
  version: 1.0.0
extends: openapi/cohesity-failover-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: 10
- target: $.paths['/data-protect/failover/pollPlannedRuns'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether failover planned runs are scheduled
      effect: read
      questions:
      - Has the planned run for my failover been scheduled yet?
      - Can I poll several failover workflows at once for their planned run status?
      instructions:
      - text: Poll planned run status for failovers {failoverIds}.
        slots:
          failoverIds: query.failoverIds
      - text: Check if failover {failoverIds} has its planned run scheduled.
        slots:
          failoverIds: query.failoverIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data-protect/failover/views/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get failover tasks of a View
      effect: read
      questions:
      - What failover tasks have run against a particular View?
      - Can I see the status of a View's failover?
      instructions:
      - text: Show failover tasks for View {id}.
        slots:
          id: path.id
      - text: Get the View failover history of {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data-protect/failover/views/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a View failover
      effect: write
      questions:
      - Can I fail over a View to its replica, either planned or unplanned?
      - What parameters does an unplanned View failover take?
      instructions:
      - text: Start a {type} failover for View {id}.
        slots:
          type: requestBody.type
          id: path.id
      - text: Run a planned failover of View {id} as type {type} with {plannedFailoverParams}.
        slots:
          id: path.id
          type: requestBody.type
          plannedFailoverParams: requestBody.plannedFailoverParams
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data-protect/failover/views/{id}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel an in-progress View failover
      effect: destructive
      questions:
      - Can I abort a View failover that's still running?
      - What stops a View failover task midway?
      instructions:
      - text: Cancel the View failover on {id}.
        slots:
          id: path.id
      - text: Abort the running failover task for View {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data-protect/failover/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Initiate a failover request
      effect: write
      questions:
      - How do I kick off a failover workflow between a source and replication cluster?
      - Which clusters need to be named when starting a failover?
      instructions:
      - text: Initiate failover {id} from {sourceCluster} to {replicationCluster}.
        slots:
          id: path.id
          sourceCluster: requestBody.sourceCluster
          replicationCluster: requestBody.replicationCluster
      - text: Start failover request {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data-protect/failover/{id}/backupActivation'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate backups on the replication cluster
      effect: write
      questions:
      - After failover, can I start backing up the failed-over objects on the replication cluster?
      - Can reverse replication be enabled when activating backups on the replica?
      instructions:
      - text: Activate backup for failover {id} on the replication cluster into protection group {protectionGroupId}.
        slots:
          id: path.id
          protectionGroupId: requestBody.protectionGroupId
      - text: Activate replica backups for failover {id} with reverse replication {enableReverseReplication}.
        slots:
          id: path.id
          enableReverseReplication: requestBody.enableReverseReplication
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data-protect/failover/{id}/backupDeactivation'].post
  update:
    x-apievangelist-phrasing:
      intent: Deactivate backups on the source cluster
      effect: write
      questions:
      - During failover, can I stop backups of the failed-over objects on the source cluster?
      - Can I keep the failover objects around when deactivating backup on the source?
      instructions:
      - text: Deactivate source backup for failover {id} toward replication cluster {replicationClusterId}.
        slots:
          id: path.id
          replicationClusterId: requestBody.replicationClusterId
      - text: Stop source-side backups in protection group {protectionGroupId} for failover {id}.
        slots:
          protectionGroupId: requestBody.protectionGroupId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data-protect/failover/{id}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a failover workflow
      effect: destructive
      questions:
      - Can I cancel a failover workflow before backup activation or deactivation has been called?
      - When is it too late to cancel a failover?
      instructions:
      - text: Cancel failover workflow {id}.
        slots:
          id: path.id
      - text: Abort the failover {id} before backups are switched.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data-protect/failover/{id}/objectLinkage'].post
  update:
    x-apievangelist-phrasing:
      intent: Link failover objects to replicated objects
      effect: write
      questions:
      - After recovering failed entities on the replica, how do I link them back to the replicated source objects?
      - What object map is needed to link failover objects?
      instructions:
      - text: Link failover objects for {id} using object map {objectMap}.
        slots:
          id: path.id
          objectMap: requestBody.objectMap
      - text: Record the object linkage for failover {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data-protect/failover/{id}/plannedRun'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a planned failover sync backup
      effect: write
      questions:
      - Can I trigger a final backup and replication run to sync clusters before a planned failover?
      - Can the planned failover run pause later scheduled runs or cancel other runs?
      instructions:
      - text: Create a planned run for failover {id} on group {protectionGroupId} with objects {objects} to cluster {replicationClusterId}.
        slots:
          id: path.id
          protectionGroupId: requestBody.protectionGroupId
          objects: requestBody.objects
          replicationClusterId: requestBody.replicationClusterId
      - text: Sync objects {objects} of group {protectionGroupId} to {replicationClusterId} for failover {id}, pausing next runs.
        slots:
          objects: requestBody.objects
          protectionGroupId: requestBody.protectionGroupId
          replicationClusterId: requestBody.replicationClusterId
          id: path.id
      method: generated
      generated: '2026-10-01'