# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Azure Azure IoT Central Scheduled Jobs API
  version: 1.0.0
extends: openapi/microsoft-azure-scheduled-jobs-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: 6
- target: $.paths['/scheduledJobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List scheduled job definitions in an application
      effect: read
      questions:
      - Which scheduled jobs are defined in my IoT Central application?
      - Can I cap how many scheduled job definitions come back per page?
      instructions:
      - text: List the scheduled job definitions in my application, {page_size} per page.
        slots:
          page_size: query.maxpagesize
      - text: Show all scheduled jobs in the app using API version {api_version}.
        slots:
          api_version: query.api-version
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scheduledJobs/{scheduledJobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a scheduled job definition
      effect: read
      questions:
      - What schedule and device group does one of my scheduled jobs use?
      - Is a particular scheduled job still enabled?
      instructions:
      - text: Show scheduled job {scheduled_job_id}.
        slots:
          scheduled_job_id: path.scheduledJobId
      - text: Get the schedule and settings of scheduled job {scheduled_job_id}.
        slots:
          scheduled_job_id: path.scheduledJobId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scheduledJobs/{scheduledJobId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a scheduled job
      effect: write
      questions:
      - How do I schedule a recurring job to run against a device group?
      - Can I set a cancellation threshold or batch size on a scheduled job?
      instructions:
      - text: Create scheduled job {scheduled_job_id} for device group {group} running {data} on schedule {schedule}.
        slots:
          scheduled_job_id: path.scheduledJobId
          group: requestBody.group
          data: requestBody.data
          schedule: requestBody.schedule
      - text: Save scheduled job {scheduled_job_id} named {display_name} with batch settings {batch}.
        slots:
          scheduled_job_id: path.scheduledJobId
          display_name: requestBody.displayName
          batch: requestBody.batch
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scheduledJobs/{scheduledJobId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a scheduled job
      effect: destructive
      questions:
      - How do I delete a scheduled job so it never runs again?
      - Can I remove a scheduled job definition by its id?
      instructions:
      - text: Delete scheduled job {scheduled_job_id}.
        slots:
          scheduled_job_id: path.scheduledJobId
      - text: Remove the scheduled job definition {scheduled_job_id} from my application.
        slots:
          scheduled_job_id: path.scheduledJobId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scheduledJobs/{scheduledJobId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch an existing scheduled job
      effect: write
      questions:
      - Can I patch part of an existing scheduled job instead of replacing it?
      - How do I update a scheduled job only if nobody else changed it?
      instructions:
      - text: Patch scheduled job {scheduled_job_id}.
        slots:
          scheduled_job_id: path.scheduledJobId
      - text: Update scheduled job {scheduled_job_id} only if its ETag is {etag}.
        slots:
          scheduled_job_id: path.scheduledJobId
          etag: header.If-Match
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scheduledJobs/{scheduledJobId}/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List job runs of a scheduled job
      effect: read
      questions:
      - Which jobs has a scheduled job definition actually launched so far?
      - How can I see the run history of one scheduled job?
      instructions:
      - text: List the jobs spawned by scheduled job {scheduled_job_id}.
        slots:
          scheduled_job_id: path.scheduledJobId
      - text: Show {page_size} runs at a time for scheduled job {scheduled_job_id}.
        slots:
          page_size: query.maxpagesize
          scheduled_job_id: path.scheduledJobId
      method: generated
      generated: '2026-10-01'