# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Optimizely Scheduled jobs API
  version: 1.0.0
extends: openapi/optimizely-scheduled-jobs-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: 7
- target: $.paths['/{clientId}/customerjobs/configured'].get
  update:
    x-apievangelist-phrasing:
      intent: List configured scheduled jobs for a client
      effect: read
      questions:
      - Which scheduled jobs are configured on my client account and what triggers them?
      - Can I cap how many configured customer jobs come back?
      instructions:
      - text: List the configured scheduled jobs for client {clientId}.
        slots:
          clientId: path.clientId
      - text: Show up to {limit} configured customer jobs with their triggers for client {clientId}.
        slots:
          limit: query.limit
          clientId: path.clientId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/customerjobs/running'].get
  update:
    x-apievangelist-phrasing:
      intent: List scheduled jobs running right now
      effect: read
      questions:
      - What scheduled jobs are running at the moment on my client account?
      - How long has each currently running customer job been going?
      instructions:
      - text: List the jobs currently running for client {clientId}.
        slots:
          clientId: path.clientId
      - text: Show start time and elapsed time of every running job in client {clientId}.
        slots:
          clientId: path.clientId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scheduled-jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List my account's experiment scheduled jobs
      effect: read
      questions:
      - What scheduled jobs belong to my Optimizely experimentation account?
      - Can I see all the recurring jobs set up across my projects' campaigns and experiments?
      instructions:
      - text: List the scheduled jobs in my account.
      - text: Show every experimentation scheduled job I own.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scheduled-jobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a scheduled job for experiments
      effect: write
      questions:
      - How do I schedule a recurring job for the experiments in a project?
      - What frequency and job type must a new scheduled job specify?
      instructions:
      - text: Create a {job_type} scheduled job in project {project_id} running {frequency}.
        slots:
          job_type: requestBody.job_type
          project_id: requestBody.project_id
          frequency: requestBody.frequency
      - text: Schedule a {job_type} job at {frequency} for experiments {experiment_ids} in project {project_id}.
        slots:
          job_type: requestBody.job_type
          frequency: requestBody.frequency
          experiment_ids: requestBody.experiment_ids
          project_id: requestBody.project_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scheduled-jobs/{job_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one scheduled job
      effect: read
      questions:
      - How do I look up the frequency and targets of a single scheduled job?
      - Can I fetch a scheduled job by its job ID?
      instructions:
      - text: Get scheduled job {job_id}.
        slots:
          job_id: path.job_id
      - text: Show the frequency and output channels of scheduled job {job_id}.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scheduled-jobs/{job_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Archive a scheduled job
      effect: destructive
      questions:
      - How do I archive a scheduled job I no longer need?
      - Does removing a scheduled job delete it or just archive it?
      instructions:
      - text: Archive scheduled job {job_id}.
        slots:
          job_id: path.job_id
      - text: Retire scheduled job {job_id} so it stops running.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scheduled-jobs/{job_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a scheduled job
      effect: write
      questions:
      - How do I change how often a scheduled job runs?
      - Can I add campaigns or change output channels on an existing scheduled job?
      instructions:
      - text: Change scheduled job {job_id} to run {frequency}.
        slots:
          job_id: path.job_id
          frequency: requestBody.frequency
      - text: Set campaigns {campaign_ids} on scheduled job {job_id}.
        slots:
          campaign_ids: requestBody.campaign_ids
          job_id: path.job_id
      method: generated
      generated: '2026-09-26'