# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Treasure Data Schedules API
  version: 1.0.0
extends: openapi/treasure-data-schedules-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['/schedule/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List scheduled queries
      effect: read
      questions:
      - Which scheduled queries are set up in my account?
      - Can I see all my recurring query schedules and their cron settings?
      instructions:
      - text: List my scheduled queries.
      - text: Show every query schedule in the account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schedule/create/{schedule_name}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a scheduled query
      effect: write
      questions:
      - How do I run a query on a recurring cron schedule?
      - Can a scheduled query retry automatically when it fails?
      instructions:
      - text: Create schedule {schedule_name} running {query} against {database} on cron {cron}.
        slots:
          schedule_name: path.schedule_name
          query: requestBody.query
          database: requestBody.database
          cron: requestBody.cron
      - text: Schedule query {query} as {schedule_name} on cron {cron} in timezone {timezone}.
        slots:
          query: requestBody.query
          schedule_name: path.schedule_name
          cron: requestBody.cron
          timezone: requestBody.timezone
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schedule/delete/{schedule_name}'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a scheduled query
      effect: destructive
      questions:
      - How do I stop and remove a recurring query schedule?
      - Can I delete a schedule by its name?
      instructions:
      - text: Delete schedule {schedule_name}.
        slots:
          schedule_name: path.schedule_name
      - text: Remove the {schedule_name} scheduled query.
        slots:
          schedule_name: path.schedule_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schedule/update/{schedule_name}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a scheduled query
      effect: write
      questions:
      - Can I change the cron timing of an existing scheduled query?
      - Is it possible to edit the SQL a schedule runs?
      instructions:
      - text: Change the cron of schedule {schedule_name} to {cron}.
        slots:
          schedule_name: path.schedule_name
          cron: requestBody.cron
      - text: Update schedule {schedule_name} to run query {query}.
        slots:
          schedule_name: path.schedule_name
          query: requestBody.query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schedule/run/{schedule_name}/{schedule_time}'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a scheduled query for a given time
      effect: write
      questions:
      - How do I manually trigger a scheduled query for a specific scheduled time?
      - Can I backfill several runs of a schedule at once?
      instructions:
      - text: Run schedule {schedule_name} for time {schedule_time}.
        slots:
          schedule_name: path.schedule_name
          schedule_time: path.schedule_time
      - text: Trigger {num} runs of schedule {schedule_name} starting at {schedule_time}.
        slots:
          num: requestBody.num
          schedule_name: path.schedule_name
          schedule_time: path.schedule_time
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schedule/history/{schedule_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a schedule's execution history
      effect: read
      questions:
      - When did a scheduled query last run and did it succeed?
      - Can I see a schedule's past executions within a range?
      instructions:
      - text: Show the execution history of schedule {schedule_name}.
        slots:
          schedule_name: path.schedule_name
      - text: Get runs of schedule {schedule_name} from {from} to {to}.
        slots:
          schedule_name: path.schedule_name
          from: query.from
          to: query.to
      method: generated
      generated: '2026-09-26'