API Evangelist conversational phrasing for CData Connect AI REST API Embedded Job API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for CData Connect AI REST API Embedded Job API
  version: 1.0.0
extends: openapi/cdata-job-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['/job/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List a sub-account's jobs
      effect: read
      questions:
      - Which caching jobs are set up for this sub-account?
      - How do I see all scheduled jobs while impersonating a service user?
      instructions:
      - text: List all jobs for this sub-account.
      - text: Show me every scheduled caching job we have.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/job/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the details of a job
      effect: read
      questions:
      - How do I check the schedule and settings of one specific job?
      - What details can I see for a single caching job?
      instructions:
      - text: Get the details of job {jobId}.
        slots:
          jobId: path.jobId
      - text: Show me the schedule and parameters configured on job {jobId}.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/job/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a scheduled caching job
      effect: write
      questions:
      - How do I schedule a caching job that runs every few hours?
      - Can I set the first run time for a new job instead of starting right away?
      - What log verbosity levels can a new job use?
      instructions:
      - text: Create a {jobType} job that runs every {intervalValue} {intervalUnit} with log verbosity {logVerbosity} and parameters {params}.
        slots:
          jobType: requestBody.jobType
          intervalValue: requestBody.intervalValue
          intervalUnit: requestBody.intervalUnit
          logVerbosity: requestBody.logVerbosity
          params: requestBody.params
      - text: Create a {jobType} job every {intervalValue} {intervalUnit}, verbosity {logVerbosity}, params {params}, with enabled set to {enabled}.
        slots:
          intervalValue: requestBody.intervalValue
          intervalUnit: requestBody.intervalUnit
          logVerbosity: requestBody.logVerbosity
          params: requestBody.params
          enabled: requestBody.enabled
          jobType: requestBody.jobType
      - text: Create a {jobType} job starting at {definedNextRun}, repeating every {intervalValue} {intervalUnit}, verbosity {logVerbosity}, params {params}.
        slots:
          jobType: requestBody.jobType
          definedNextRun: requestBody.definedNextRun
          intervalValue: requestBody.intervalValue
          intervalUnit: requestBody.intervalUnit
          logVerbosity: requestBody.logVerbosity
          params: requestBody.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/job/{jobId}/update'].put
  update:
    x-apievangelist-phrasing:
      intent: Change an existing job's schedule or settings
      effect: write
      questions:
      - How do I change how often an existing caching job runs?
      - Can I pause an existing job by disabling it rather than deleting it?
      instructions:
      - text: Change job {jobId} to a {jobType} job every {intervalValue} {intervalUnit} with verbosity {logVerbosity} and params {params}.
        slots:
          jobId: path.jobId
          jobType: requestBody.jobType
          intervalValue: requestBody.intervalValue
          intervalUnit: requestBody.intervalUnit
          logVerbosity: requestBody.logVerbosity
          params: requestBody.params
      - text: Set existing job {jobId} enabled to {enabled}, keeping type {jobType}, every {intervalValue} {intervalUnit}, verbosity {logVerbosity}, params {params}.
        slots:
          jobId: path.jobId
          enabled: requestBody.enabled
          jobType: requestBody.jobType
          intervalValue: requestBody.intervalValue
          intervalUnit: requestBody.intervalUnit
          logVerbosity: requestBody.logVerbosity
          params: requestBody.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/job/{jobId}/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a job
      effect: destructive
      questions:
      - How do I permanently remove a caching job I no longer need?
      - Can I delete a scheduled job so it never runs again?
      instructions:
      - text: Delete job {jobId}.
        slots:
          jobId: path.jobId
      - text: Remove the scheduled job {jobId} for good.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/job/{jobId}/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Queue a job to run now
      effect: write
      questions:
      - Can I trigger a caching job immediately instead of waiting for its schedule?
      - How do I kick off a job run on demand?
      instructions:
      - text: Run job {jobId} now.
        slots:
          jobId: path.jobId
      - text: Put job {jobId} in the queue to run right away.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/job/{jobId}/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop a running job
      effect: destructive
      questions:
      - How do I halt a job that is currently running?
      - Can I cancel a caching job run that is taking too long?
      instructions:
      - text: Stop job {jobId}.
        slots:
          jobId: path.jobId
      - text: Halt the in-progress run of job {jobId}.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'