# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Scheduler API
  version: 1.0.0
extends: openapi/conga-scheduler-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: 12
- target: $.paths['/api/scheduler/v1/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List scheduled jobs
      effect: read
      questions:
      - Which jobs are scheduled to run in my Conga platform?
      - Can I list scheduled jobs for just one app namespace?
      instructions:
      - text: List all scheduled jobs.
      - text: Show scheduled jobs in namespace {appNamespace}, {pageSize} per page.
        slots:
          appNamespace: query.appNamespace
          pageSize: query.pageSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/scheduler/v1/jobs/cron'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule a recurring cron job
      effect: write
      questions:
      - How do I schedule a job that runs on a cron expression?
      - Can a recurring job be limited to a start and end date in a specific timezone?
      instructions:
      - text: Create cron job {JobName} running on {CronExpression}.
        slots:
          JobName: requestBody.JobName
          CronExpression: requestBody.CronExpression
      - text: Schedule recurring job {JobName} in timezone {TimezoneId} from {StartDateTimeUtc} to {EndDateTimeUtc}.
        slots:
          JobName: requestBody.JobName
          TimezoneId: requestBody.TimezoneId
          StartDateTimeUtc: requestBody.StartDateTimeUtc
          EndDateTimeUtc: requestBody.EndDateTimeUtc
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/scheduler/v1/jobs/export'].post
  update:
    x-apievangelist-phrasing:
      intent: Export all scheduled jobs as a ZIP
      effect: read
      questions:
      - Can I download every scheduled job's definition in one zip file?
      - What's the way to back up all scheduled jobs for an app namespace?
      instructions:
      - text: Export all scheduled jobs to a zip.
      - text: Export every scheduled job in namespace {appNamespace}.
        slots:
          appNamespace: query.appNamespace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/scheduler/v1/jobs/onetime'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule a one-time job
      effect: write
      questions:
      - How do I schedule a job to run once at a specific time?
      - Can I set a single future execution time for a job?
      instructions:
      - text: Schedule one-time job {JobName} to run at {ExecutionDateTimeUtc}.
        slots:
          JobName: requestBody.JobName
          ExecutionDateTimeUtc: requestBody.ExecutionDateTimeUtc
      - text: Create a run-once job {JobName} with action {ActionType}.
        slots:
          JobName: requestBody.JobName
          ActionType: requestBody.ActionType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/scheduler/v1/jobs/{jobName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a scheduled job's details
      effect: read
      questions:
      - What schedule and payload does a named job have?
      - How do I look up one scheduled job by name?
      instructions:
      - text: Get scheduled job {jobName}.
        slots:
          jobName: path.jobName
      - text: Show the details of job {jobName} in namespace {appNamespace}.
        slots:
          jobName: path.jobName
          appNamespace: query.appNamespace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/scheduler/v1/jobs/{jobName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a scheduled job
      effect: destructive
      questions:
      - Does deleting a scheduled job also wipe its execution history?
      - How do I permanently remove a scheduled job?
      instructions:
      - text: Delete scheduled job {jobName}.
        slots:
          jobName: path.jobName
      - text: Remove job {jobName} and its run history.
        slots:
          jobName: path.jobName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/scheduler/v1/jobs/{jobName}/cron'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a cron job's schedule
      effect: write
      questions:
      - Can I change the cron expression of an existing scheduled job?
      - How do I move a recurring job to a new timezone or end date?
      instructions:
      - text: Change job {jobName} to run on {CronExpression}.
        slots:
          jobName: path.jobName
          CronExpression: requestBody.CronExpression
      - text: Update scheduled job {jobName} to end at {EndDateTimeUtc}.
        slots:
          jobName: path.jobName
          EndDateTimeUtc: requestBody.EndDateTimeUtc
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/scheduler/v1/jobs/{jobName}/disable'].put
  update:
    x-apievangelist-phrasing:
      intent: Pause a scheduled job
      effect: write
      questions:
      - Can I stop a scheduled job from running without deleting it?
      - What's the way to temporarily switch off a job?
      instructions:
      - text: Disable scheduled job {jobName}.
        slots:
          jobName: path.jobName
      - text: Pause job {jobName} so it stops running.
        slots:
          jobName: path.jobName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/scheduler/v1/jobs/{jobName}/enable'].put
  update:
    x-apievangelist-phrasing:
      intent: Re-enable a scheduled job
      effect: write
      questions:
      - How do I turn a disabled job back on?
      - Can a paused scheduled job resume its schedule?
      instructions:
      - text: Enable scheduled job {jobName}.
        slots:
          jobName: path.jobName
      - text: Resume job {jobName}'s schedule.
        slots:
          jobName: path.jobName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/scheduler/v1/jobs/{jobName}/execute'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a scheduled job now
      effect: write
      questions:
      - Can I trigger a scheduled job immediately instead of waiting?
      - What's returned when I manually execute a job?
      instructions:
      - text: Run job {jobName} now.
        slots:
          jobName: path.jobName
      - text: Execute scheduled job {jobName} immediately in namespace {appNamespace}.
        slots:
          jobName: path.jobName
          appNamespace: query.appNamespace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/scheduler/v1/jobs/{jobName}/execution-history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a job's execution history
      effect: read
      questions:
      - When did a scheduled job last run and did it succeed?
      - Can I page through a job's past executions?
      instructions:
      - text: Show execution history of job {jobName}.
        slots:
          jobName: path.jobName
      - text: List past runs of {jobName}, page {PageNumber}.
        slots:
          jobName: path.jobName
          PageNumber: query.PageNumber
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/scheduler/v1/jobs/{jobName}/export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export one scheduled job
      effect: read
      questions:
      - Can I download a single job's definition as a ZIP?
      - Is there a way to export just one named job?
      instructions:
      - text: Export scheduled job {jobName} as a zip.
        slots:
          jobName: path.jobName
      - text: Download the definition of job {jobName}.
        slots:
          jobName: path.jobName
      method: generated
      generated: '2026-10-01'