# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Adobe Suite Schedules API
  version: 1.0.0
extends: openapi/adobe-suite-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: 14
- target: $.paths['/schedules'].get
  update:
    x-apievangelist-phrasing:
      intent: List scheduled queries
      effect: read
      questions:
      - How do I see every scheduled SQL query my organization has set up?
      - Can I sort and page through the list of query schedules?
      instructions:
      - text: List all query schedules in sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      - text: Show the first {limit} scheduled queries ordered by {orderby}.
        slots:
          limit: query.limit
          orderby: query.orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schedules'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule a query to run on a recurrence
      effect: write
      questions:
      - How can I make a Query Service SQL query run automatically on a schedule?
      - What do I need to supply to set up a recurring query?
      instructions:
      - text: Schedule the query {query} to run on {schedule}.
        slots:
          query: requestBody.query
          schedule: requestBody.schedule
      - text: Create a query schedule in sandbox {sandbox} that runs {query} with schedule {schedule}.
        slots:
          sandbox: header.x-sandbox-name
          query: requestBody.query
          schedule: requestBody.schedule
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schedules/{schedulesId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of a scheduled query
      effect: read
      questions:
      - When was my scheduled query created and what state is it in?
      - Can I check the details of one query schedule by its ID?
      instructions:
      - text: Show the scheduled query {schedulesId}.
        slots:
          schedulesId: path.schedulesId
      - text: Get the state and dates of query schedule {schedulesId}.
        slots:
          schedulesId: path.schedulesId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schedules/{schedulesId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a scheduled query
      effect: destructive
      questions:
      - How do I stop and remove a query schedule entirely?
      - Can a scheduled SQL query be deleted?
      instructions:
      - text: Delete query schedule {schedulesId}.
        slots:
          schedulesId: path.schedulesId
      - text: Remove the scheduled query {schedulesId} permanently.
        slots:
          schedulesId: path.schedulesId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schedules/{schedulesId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a scheduled query
      effect: write
      questions:
      - Can I change the details of an existing query schedule, like disabling it?
      - What's the way to modify a scheduled SQL query after it's created?
      instructions:
      - text: Update the scheduled query {schedulesId}.
        slots:
          schedulesId: path.schedulesId
      - text: Apply the patch {body} to query schedule {schedulesId}.
        slots:
          body: requestBody.body
          schedulesId: path.schedulesId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schedules/{schedulesId}/runs'].get
  update:
    x-apievangelist-phrasing:
      intent: List the runs of a scheduled query
      effect: read
      questions:
      - How can I see the run history of a scheduled query?
      - Can I page through past executions of one query schedule?
      instructions:
      - text: List the runs of schedule {schedulesId}.
        slots:
          schedulesId: path.schedulesId
      - text: Show the last {limit} runs for scheduled query {schedulesId}.
        slots:
          limit: query.limit
          schedulesId: path.schedulesId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schedules/{schedulesId}/runs'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a scheduled query immediately
      effect: write
      questions:
      - Can I kick off a scheduled query right now instead of waiting for its next slot?
      - Is there an on-demand trigger for a query schedule?
      instructions:
      - text: Trigger an immediate run of schedule {schedulesId}.
        slots:
          schedulesId: path.schedulesId
      - text: Run scheduled query {schedulesId} now.
        slots:
          schedulesId: path.schedulesId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schedules/{schedulesId}/runs/{runId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one scheduled query run
      effect: read
      questions:
      - How do I check whether a particular run of my scheduled query succeeded?
      - What details are available for a single scheduled query execution?
      instructions:
      - text: Show run {runId} of scheduled query {schedulesId}.
        slots:
          runId: path.runId
          schedulesId: path.schedulesId
      - text: Get the status of execution {runId} under schedule {schedulesId}.
        slots:
          runId: path.runId
          schedulesId: path.schedulesId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schedules/{schedulesId}/runs/{runId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Cancel a run of a scheduled query
      effect: destructive
      questions:
      - Can I cancel a scheduled query run that's taking too long?
      - How do I abort one specific execution of a query schedule?
      instructions:
      - text: Cancel run {runId} of scheduled query {schedulesId}.
        slots:
          runId: path.runId
          schedulesId: path.schedulesId
      - text: Abort execution {runId} for schedule {schedulesId}.
        slots:
          runId: path.runId
          schedulesId: path.schedulesId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config/schedules'].get
  update:
    x-apievangelist-phrasing:
      intent: List segmentation job schedules
      effect: read
      questions:
      - Which config schedules, such as batch segmentation jobs, exist in my sandbox?
      - Can I page through the scheduler's configured schedules?
      instructions:
      - text: List the config schedules in sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      - text: Show {limit} segmentation schedules starting at {start}.
        slots:
          limit: query.limit
          start: query.start
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config/schedules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a segmentation job schedule
      effect: write
      questions:
      - How do I schedule a batch segmentation job to trigger at a set time?
      - Why doesn't a newly created schedule take effect right away?
      instructions:
      - text: Create schedule {name} of type {type} that triggers on {schedule}.
        slots:
          name: requestBody.name
          type: requestBody.type
          schedule: requestBody.schedule
      - text: Set up a config schedule {name} with properties {properties} and cron {schedule} in state {state}.
        slots:
          name: requestBody.name
          properties: requestBody.properties
          schedule: requestBody.schedule
          state: requestBody.state
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config/schedules/{SCHEDULE_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a segmentation job schedule
      effect: read
      questions:
      - Can I look up the trigger time and state of one config schedule?
      - Where do I see the settings of a segmentation schedule by its ID?
      instructions:
      - text: Show config schedule {SCHEDULE_ID}.
        slots:
          SCHEDULE_ID: path.SCHEDULE_ID
      - text: Get the settings of segmentation schedule {SCHEDULE_ID}.
        slots:
          SCHEDULE_ID: path.SCHEDULE_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config/schedules/{SCHEDULE_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a segmentation job schedule
      effect: destructive
      questions:
      - How do I remove a config schedule so the segmentation job stops running?
      - Can a segmentation schedule be deleted?
      instructions:
      - text: Delete config schedule {SCHEDULE_ID}.
        slots:
          SCHEDULE_ID: path.SCHEDULE_ID
      - text: Remove segmentation schedule {SCHEDULE_ID}.
        slots:
          SCHEDULE_ID: path.SCHEDULE_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config/schedules/{SCHEDULE_ID}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a segmentation schedule's time or state
      effect: write
      questions:
      - Can I change when a segmentation schedule triggers or turn it off?
      - How long until an edit to a config schedule actually applies?
      instructions:
      - text: Disable config schedule {SCHEDULE_ID}.
        slots:
          SCHEDULE_ID: path.SCHEDULE_ID
      - text: Change the trigger time of segmentation schedule {SCHEDULE_ID}.
        slots:
          SCHEDULE_ID: path.SCHEDULE_ID
      method: generated
      generated: '2026-09-26'