# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Treasure Workflow Schedule API
  version: 1.0.0
extends: openapi/treasure-data-schedule-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/api/schedules'].get
  update:
    x-apievangelist-phrasing:
      intent: List workflow schedules
      effect: read
      questions:
      - What workflow schedules are set up in my account?
      - Can I page through all schedules across projects?
      instructions:
      - text: List all workflow schedules.
      - text: Show every schedule across my workflow projects.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/schedules/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workflow schedule
      effect: read
      questions:
      - When is a particular schedule set to run next?
      - How do I see the details of one schedule?
      instructions:
      - text: Show schedule {id}.
        slots:
          id: path.id
      - text: Tell me when schedule {id} runs next.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/schedules/{id}/backfill'].post
  update:
    x-apievangelist-phrasing:
      intent: Backfill sessions for past schedule times
      effect: write
      questions:
      - How do I rerun a workflow for schedule times it missed in the past?
      - Can I dry-run a backfill to see which sessions it would create?
      instructions:
      - text: Backfill schedule {id} from {fromTime} with dry run {dryRun}.
        slots:
          id: path.id
          fromTime: requestBody.fromTime
          dryRun: requestBody.dryRun
      - text: Backfill {count} past sessions of schedule {id}, dry run {dryRun}.
        slots:
          count: requestBody.count
          id: path.id
          dryRun: requestBody.dryRun
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/schedules/{id}/disable'].post
  update:
    x-apievangelist-phrasing:
      intent: Pause a workflow schedule
      effect: write
      questions:
      - How do I stop a schedule from starting new sessions?
      - Can I pause a workflow schedule temporarily?
      instructions:
      - text: Disable schedule {id}.
        slots:
          id: path.id
      - text: Pause schedule {id} so it starts no new sessions.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/schedules/{id}/enable'].post
  update:
    x-apievangelist-phrasing:
      intent: Re-enable a disabled schedule
      effect: write
      questions:
      - How do I turn a paused schedule back on?
      - Can I resume a schedule and set when it runs next?
      instructions:
      - text: Enable schedule {id}.
        slots:
          id: path.id
      - text: Re-enable schedule {id} with next run at {nextTime}.
        slots:
          id: path.id
          nextTime: requestBody.nextTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/schedules/{id}/skip'].post
  update:
    x-apievangelist-phrasing:
      intent: Skip upcoming sessions of a schedule
      effect: write
      questions:
      - Can I skip the next few runs of a workflow schedule?
      - How do I jump a schedule forward to a later run time?
      instructions:
      - text: Skip the next {count} sessions of schedule {id}, dry run {dryRun}.
        slots:
          count: requestBody.count
          id: path.id
          dryRun: requestBody.dryRun
      - text: Skip schedule {id} ahead to {nextTime} with dry run {dryRun}.
        slots:
          id: path.id
          nextTime: requestBody.nextTime
          dryRun: requestBody.dryRun
      method: generated
      generated: '2026-09-26'