# 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 Protection Jobs API
  version: 1.0.0
extends: openapi/cohesity-protectionjobs-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['/public/protectionJobState/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Pause or resume a protection job
      effect: write
      questions:
      - How do I pause a backup job so no new runs start?
      - Do runs already in progress keep going when I pause a protection job?
      instructions:
      - text: Pause protection job {id}.
        slots:
          id: path.id
      - text: Pause protection job {id} with reason {pauseReason}.
        slots:
          id: path.id
          pauseReason: requestBody.pauseReason
      - text: Resume future runs of protection job {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/protectionJobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List protection jobs
      effect: read
      questions:
      - Which backup jobs on the cluster protect VMware workloads?
      - Can I find jobs whose last run violated its SLA?
      - What protection jobs were deleted but still have snapshots?
      instructions:
      - text: List protection jobs for environment {environments}.
        slots:
          environments: query.environments
      - text: Show protection jobs using policy {policyIds} with their last run stats.
        slots:
          policyIds: query.policyIds
      - text: List jobs whose last run missed its SLA.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/protectionJobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a protection job
      effect: write
      questions:
      - How do I set up a new backup job for a set of VMs?
      - Which storage domain and policy does a new protection job need?
      instructions:
      - text: Create protection job {name} with policy {policyId} writing to storage domain {viewBoxId}.
        slots:
          name: requestBody.name
          policyId: requestBody.policyId
          viewBoxId: requestBody.viewBoxId
      - text: Create job {name} protecting sources {sourceIds} in environment {environment} under policy {policyId} on domain {viewBoxId}.
        slots:
          name: requestBody.name
          sourceIds: requestBody.sourceIds
          environment: requestBody.environment
          policyId: requestBody.policyId
          viewBoxId: requestBody.viewBoxId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/protectionJobs/run/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a protection job now
      effect: write
      questions:
      - Can I kick off a backup immediately instead of waiting for the schedule?
      - Is it possible to run a full backup for only some of a job's sources?
      instructions:
      - text: Run protection job {id} now.
        slots:
          id: path.id
      - text: Run a {runType} backup of job {id} for sources {sourceIds}.
        slots:
          runType: requestBody.runType
          id: path.id
          sourceIds: requestBody.sourceIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/protectionJobs/states'].post
  update:
    x-apievangelist-phrasing:
      intent: Pause, resume or deactivate many jobs at once
      effect: write
      questions:
      - How do I pause every backup job in a list with a single request?
      - Can I deactivate several protection jobs together?
      instructions:
      - text: Apply action {action} to protection jobs {jobIds}.
        slots:
          action: requestBody.action
          jobIds: requestBody.jobIds
      - text: Deactivate all of jobs {jobIds} in one go.
        slots:
          jobIds: requestBody.jobIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/protectionJobs/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a protection job
      effect: read
      questions:
      - What sources and policy does a specific protection job use?
      - Can I see the full configuration of one backup job?
      instructions:
      - text: Get protection job {id}.
        slots:
          id: path.id
      - text: Show the configuration of backup job {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/protectionJobs/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a protection job
      effect: write
      questions:
      - How do I switch an existing backup job to a different policy?
      - Can I change a job's start time or timezone after creating it?
      instructions:
      - text: Change protection job {id} to use policy {policyId}.
        slots:
          id: path.id
          policyId: requestBody.policyId
      - text: Set job {id}'s start time to {startTime} in timezone {timezone}.
        slots:
          id: path.id
          startTime: requestBody.startTime
          timezone: requestBody.timezone
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/protectionJobs/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a protection job
      effect: destructive
      questions:
      - When I delete a backup job, are its snapshots deleted too?
      - How do I remove a protection job but keep its existing snapshots?
      instructions:
      - text: Delete protection job {id} and keep its snapshots.
        slots:
          id: path.id
      - text: Delete job {id}, setting snapshot deletion to {deleteSnapshots}.
        slots:
          id: path.id
          deleteSnapshots: requestBody.deleteSnapshots
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/protectionJobs/{id}/auditTrail'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a protection job's edit history
      effect: read
      questions:
      - Who changed a backup job and when?
      - Can I see the audit trail of edits to a protection job?
      instructions:
      - text: Show the audit trail for protection job {id}.
        slots:
          id: path.id
      - text: List the edit history of job {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'