# 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 Runs API
  version: 1.0.0
extends: openapi/cohesity-protectionruns-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: 4
- target: $.paths['/public/protectionRuns'].get
  update:
    x-apievangelist-phrasing:
      intent: List protection job runs
      effect: read
      questions:
      - Which backup job runs happened recently on my cluster?
      - Can I exclude failed runs when listing a job's runs?
      - What runs did a protection job have in a time window?
      instructions:
      - text: List runs of protection job {jobId}.
        slots:
          jobId: query.jobId
      - text: Show the last {numRuns} runs of job {jobId}.
        slots:
          numRuns: query.numRuns
          jobId: query.jobId
      - text: List job runs between {startTimeUsecs} and {endTimeUsecs}.
        slots:
          startTimeUsecs: query.startTimeUsecs
          endTimeUsecs: query.endTimeUsecs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/protectionRuns'].put
  update:
    x-apievangelist-phrasing:
      intent: Change retention of protection job runs
      effect: write
      questions:
      - How do I extend how long a backup run's snapshots are kept?
      - Can I shorten retention so old job runs expire sooner?
      instructions:
      - text: Update retention for job runs {jobRuns}.
        slots:
          jobRuns: requestBody.jobRuns
      - text: 'Change the expiration date on these protection runs: {jobRuns}.'
        slots:
          jobRuns: requestBody.jobRuns
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/protectionRuns/cancel/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a protection job run
      effect: destructive
      questions:
      - How do I cancel a backup job run that's in progress?
      - Can I cancel just one copy task of a job run?
      instructions:
      - text: Cancel the run of protection job {id}.
        slots:
          id: path.id
      - text: Cancel job run {jobRunId} of protection job {id}.
        slots:
          jobRunId: requestBody.jobRunId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/protectionRuns/errors'].get
  update:
    x-apievangelist-phrasing:
      intent: List errors from a protection job run task
      effect: read
      questions:
      - Why did a backup job run task fail?
      - Can I see the error list for a specific job run task?
      instructions:
      - text: List errors for job {jobId}, run started {startTimeUsecs}, task {taskId}.
        slots:
          jobId: query.jobId
          startTimeUsecs: query.startTimeUsecs
          taskId: query.taskId
      - text: Show up to {limitNumberOfErrors} errors for task {taskId} of job {jobId} run at {startTimeUsecs}.
        slots:
          limitNumberOfErrors: query.limitNumberOfErrors
          taskId: query.taskId
          jobId: query.jobId
          startTimeUsecs: query.startTimeUsecs
      method: generated
      generated: '2026-10-01'