# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Helios Reporting service Schedules API
  version: 1.0.0
extends: openapi/cohesity-schedules-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: 7
- target: $.paths['/public/schedules'].get
  update:
    x-apievangelist-phrasing:
      intent: List report schedules
      effect: read
      questions:
      - Which report schedules are currently active?
      - Can I find every schedule that emails a particular address?
      instructions:
      - text: List schedules for reports {reportIds}.
        slots:
          reportIds: query.reportIds
      - text: Show {state} report schedules with their latest task info.
        slots:
          state: query.state
      - text: List report schedules sent to {emailIds}.
        slots:
          emailIds: query.emailIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/schedules'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule a report for delivery
      effect: write
      questions:
      - How do I get a report emailed to my team every week?
      - Can a scheduled report be delivered as PDF or CSV?
      instructions:
      - text: Schedule report {reportId} at {scheduleTime}.
        slots:
          reportId: requestBody.reportId
          scheduleTime: requestBody.scheduleTime
      - text: Schedule report {reportId} at {scheduleTime} and email it to {emailIds} as {reportFormat}.
        slots:
          reportId: requestBody.reportId
          scheduleTime: requestBody.scheduleTime
          emailIds: requestBody.emailIds
          reportFormat: requestBody.reportFormat
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/schedules/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a report schedule
      effect: read
      questions:
      - How do I see the details of one report schedule?
      - When does a particular schedule send its report?
      instructions:
      - text: Get report schedule {id}.
        slots:
          id: path.id
      - text: Show schedule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/schedules/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a report schedule
      effect: write
      questions:
      - Can I change who receives a scheduled report?
      - How do I move a report schedule to a different time?
      instructions:
      - text: Update schedule {id} for report {reportId} to run at {scheduleTime}.
        slots:
          id: path.id
          reportId: requestBody.reportId
          scheduleTime: requestBody.scheduleTime
      - text: Change schedule {id} for report {reportId} at {scheduleTime} to email {emailIds}.
        slots:
          id: path.id
          reportId: requestBody.reportId
          scheduleTime: requestBody.scheduleTime
          emailIds: requestBody.emailIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/schedules/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a report schedule
      effect: destructive
      questions:
      - How do I stop a report from being sent permanently?
      - Can I delete a report schedule?
      instructions:
      - text: Delete report schedule {id}.
        slots:
          id: path.id
      - text: Remove schedule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/schedules/{id}/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a scheduled report now
      effect: write
      questions:
      - Can I trigger a scheduled report immediately instead of waiting?
      - Is there a way to re-send a report schedule on demand?
      instructions:
      - text: Run report schedule {id} now.
        slots:
          id: path.id
      - text: Send schedule {id} on demand.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/schedules/state'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate or deactivate report schedules
      effect: write
      questions:
      - Can I pause several report schedules at once?
      - How do I reactivate inactive schedules in bulk?
      instructions:
      - text: Set report schedules {ids} to {state}.
        slots:
          ids: requestBody.ids
          state: requestBody.state
      - text: Change the state of all schedules to {state}.
        slots:
          state: requestBody.state
      method: generated
      generated: '2026-10-01'