# 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 Jobschedules API
  version: 1.0.0
extends: openapi/microsoft-azure-jobschedules-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: 11
- target: $.paths['/jobschedules'].get
  update:
    x-apievangelist-phrasing:
      intent: List job schedules in a Batch account
      effect: read
      questions:
      - Which recurring job schedules are set up in my Azure Batch account?
      - Can I filter job schedules with an OData expression and cap the results?
      instructions:
      - text: List all job schedules in my Batch account.
      - text: List Batch job schedules matching {filter}, at most {maxresults}.
        slots:
          filter: query.$filter
          maxresults: query.maxresults
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobschedules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a recurring Batch job schedule
      effect: write
      questions:
      - How do I set up a Batch job to be created automatically on a schedule?
      - What do I need to supply to create a job schedule — an ID, a schedule and a job spec?
      instructions:
      - text: Create job schedule {id} running on schedule {schedule} with job specification {jobSpecification}.
        slots:
          id: requestBody.id
          schedule: requestBody.schedule
          jobSpecification: requestBody.jobSpecification
      - text: Add a Batch job schedule {id} named {displayName}.
        slots:
          id: requestBody.id
          displayName: requestBody.displayName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobschedules/{jobScheduleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Batch job schedule
      effect: read
      questions:
      - What state is a particular job schedule in and when does it next run?
      - Can I fetch a job schedule only if it changed since a certain time?
      instructions:
      - text: Get job schedule {jobScheduleId}.
        slots:
          jobScheduleId: path.jobScheduleId
      - text: Show the details of Batch job schedule {jobScheduleId}, selecting {select}.
        slots:
          jobScheduleId: path.jobScheduleId
          select: query.$select
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobschedules/{jobScheduleId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace all properties of a job schedule
      effect: write
      questions:
      - How do I fully overwrite a job schedule's configuration, dropping anything I leave out?
      - If I replace a job schedule without a schedule property, is the existing schedule removed?
      instructions:
      - text: Replace job schedule {jobScheduleId} entirely with job specification {jobSpecification}.
        slots:
          jobScheduleId: path.jobScheduleId
          jobSpecification: requestBody.jobSpecification
      - text: Fully overwrite {jobScheduleId} with schedule {schedule} and job spec {jobSpecification}.
        slots:
          jobScheduleId: path.jobScheduleId
          schedule: requestBody.schedule
          jobSpecification: requestBody.jobSpecification
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobschedules/{jobScheduleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Batch job schedule
      effect: destructive
      questions:
      - Does deleting a job schedule also delete the jobs and tasks it created?
      - How do I remove a job schedule from my Batch account for good?
      instructions:
      - text: Delete job schedule {jobScheduleId} and all its jobs.
        slots:
          jobScheduleId: path.jobScheduleId
      - text: Remove Batch job schedule {jobScheduleId} from the account.
        slots:
          jobScheduleId: path.jobScheduleId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobschedules/{jobScheduleId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update selected job schedule properties
      effect: write
      questions:
      - Can I change just the schedule of a job schedule while keeping its job spec?
      - Which job schedule properties can I patch without touching the rest?
      instructions:
      - text: Change only the schedule of job schedule {jobScheduleId} to {schedule}.
        slots:
          jobScheduleId: path.jobScheduleId
          schedule: requestBody.schedule
      - text: Patch the metadata of job schedule {jobScheduleId} to {metadata}.
        slots:
          jobScheduleId: path.jobScheduleId
          metadata: requestBody.metadata
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobschedules/{jobScheduleId}'].head
  update:
    x-apievangelist-phrasing:
      intent: Check a Batch job schedule exists
      effect: read
      questions:
      - Is there a cheap way to check that a job schedule ID is already taken?
      - Can I confirm a job schedule exists without retrieving it?
      instructions:
      - text: Check whether job schedule {jobScheduleId} exists.
        slots:
          jobScheduleId: path.jobScheduleId
      - text: Confirm Batch job schedule {jobScheduleId} is present.
        slots:
          jobScheduleId: path.jobScheduleId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobschedules/{jobScheduleId}/disable'].post
  update:
    x-apievangelist-phrasing:
      intent: Pause a Batch job schedule
      effect: write
      questions:
      - How do I temporarily stop a job schedule from creating new jobs?
      - Can I pause a job schedule and turn it back on later?
      instructions:
      - text: Disable job schedule {jobScheduleId}.
        slots:
          jobScheduleId: path.jobScheduleId
      - text: Pause {jobScheduleId} so it stops creating new jobs.
        slots:
          jobScheduleId: path.jobScheduleId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobschedules/{jobScheduleId}/enable'].post
  update:
    x-apievangelist-phrasing:
      intent: Re-enable a paused job schedule
      effect: write
      questions:
      - How do I turn a disabled job schedule back on?
      - Can a paused job schedule resume creating jobs?
      instructions:
      - text: Enable job schedule {jobScheduleId}.
        slots:
          jobScheduleId: path.jobScheduleId
      - text: Resume the disabled Batch job schedule {jobScheduleId}.
        slots:
          jobScheduleId: path.jobScheduleId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobschedules/{jobScheduleId}/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List jobs created by a job schedule
      effect: read
      questions:
      - Which jobs has a particular job schedule created so far?
      - Can I filter the jobs a schedule produced by state?
      instructions:
      - text: List the jobs created under job schedule {jobScheduleId}.
        slots:
          jobScheduleId: path.jobScheduleId
      - text: Show jobs from schedule {jobScheduleId} matching {filter}.
        slots:
          jobScheduleId: path.jobScheduleId
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobschedules/{jobScheduleId}/terminate'].post
  update:
    x-apievangelist-phrasing:
      intent: Terminate a Batch job schedule
      effect: destructive
      questions:
      - How do I permanently end a job schedule rather than just pausing it?
      - Can I terminate a job schedule so it never runs again?
      instructions:
      - text: Terminate job schedule {jobScheduleId}.
        slots:
          jobScheduleId: path.jobScheduleId
      - text: End Batch job schedule {jobScheduleId} for good.
        slots:
          jobScheduleId: path.jobScheduleId
      method: generated
      generated: '2026-09-26'