# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin API V1 Integration Jobs API
  version: 1.0.0
extends: openapi/optimizely-integration-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: 11
- target: $.paths['/api/v1/admin/IntegrationJobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List integration job runs
      effect: read
      questions:
      - How can I see recent integration job runs and their status?
      - Can I filter job runs to failed ones or count how many ran today?
      instructions:
      - text: List all integration job runs.
      - text: List integration jobs matching {filter}, newest first by {orderby}, top {top}.
        slots:
          filter: query.$filter
          orderby: query.$orderby
          top: query.$top
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/IntegrationJobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Queue an integration job
      effect: write
      questions:
      - Can I kick off a new run of an existing job definition?
      - Is it possible to schedule an integration job for a later time?
      instructions:
      - text: Create an integration job for definition {jobDefinitionId} with status {status}.
        slots:
          jobDefinitionId: requestBody.jobDefinitionId
          status: requestBody.status
      - text: Schedule job definition {jobDefinitionId} to run at {scheduleDateTime}.
        slots:
          jobDefinitionId: requestBody.jobDefinitionId
          scheduleDateTime: requestBody.scheduleDateTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/IntegrationJobs({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an integration job run
      effect: read
      questions:
      - How many records did a specific integration job add, modify or delete?
      - Can I check the error and warning counts of one job run?
      instructions:
      - text: Show integration job {id}.
        slots:
          id: path.id
      - text: Get integration job {id} returning only {select}.
        slots:
          id: path.id
          select: query.$select
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/IntegrationJobs({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an integration job record
      effect: write
      questions:
      - Can I overwrite a whole integration job record?
      - What's the full-replace call for a job run?
      instructions:
      - text: Replace integration job {id} with status {status} and notes {notes}.
        slots:
          id: path.id
          status: requestBody.status
          notes: requestBody.notes
      - text: Overwrite integration job {id} entirely for definition {jobDefinitionId}.
        slots:
          id: path.id
          jobDefinitionId: requestBody.jobDefinitionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/IntegrationJobs({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an integration job run
      effect: destructive
      questions:
      - How do I remove one integration job run from history?
      - Can I delete a job run only if it hasn't changed since I read it?
      instructions:
      - text: Delete integration job {id}.
        slots:
          id: path.id
      - text: Delete integration job {id} if its ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/IntegrationJobs({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an integration job's status
      effect: write
      questions:
      - Can I change only the status of an integration job run?
      - Is there a partial update to add notes to a job?
      instructions:
      - text: Set integration job {id} status to {status}.
        slots:
          id: path.id
          status: requestBody.status
      - text: Add notes {notes} to integration job {id}.
        slots:
          notes: requestBody.notes
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/IntegrationJobs/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for an integration job
      effect: read
      questions:
      - What defaults are pre-filled for a new integration job?
      - Is there a blank template for an integration job run?
      instructions:
      - text: Get the default integration job template.
      - text: Show pre-filled values for a new integration job.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/integrationjobs/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several integration job runs
      effect: destructive
      questions:
      - Can I purge a batch of old integration job runs at once?
      - Which call bulk removes integration jobs by ID?
      instructions:
      - text: Bulk delete integration jobs {ids}.
        slots:
          ids: query.ids
      - text: Purge the integration job runs {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/integrationjobs({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on an integration job
      effect: read
      questions:
      - Can I read a custom field stored on an integration job run?
      - Where are extra attributes of a job run kept?
      instructions:
      - text: Get custom property {custompropertyKey} on integration job {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show integration job {key}'s custom field {custompropertyKey}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/integrationjobs({key})/integrationjoblogs({integrationjoblogKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a log entry from an integration job
      effect: read
      questions:
      - Can I read a single log message written during an integration job run?
      - Where do I see why a job run logged an error?
      instructions:
      - text: Get log entry {integrationjoblogKey} of integration job {key}.
        slots:
          integrationjoblogKey: path.integrationjoblogKey
          key: path.key
      - text: Show integration job {key}'s log line {integrationjoblogKey}.
        slots:
          key: path.key
          integrationjoblogKey: path.integrationjoblogKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/integrationjobs({key})/integrationjobparameters({integrationjobparameterKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a parameter used by an integration job
      effect: read
      questions:
      - What parameter value was a specific integration job run started with?
      - Can I read one runtime parameter on a job run?
      instructions:
      - text: Get parameter {integrationjobparameterKey} of integration job {key}.
        slots:
          integrationjobparameterKey: path.integrationjobparameterKey
          key: path.key
      - text: Show integration job {key}'s runtime parameter {integrationjobparameterKey}.
        slots:
          key: path.key
          integrationjobparameterKey: path.integrationjobparameterKey
      method: generated
      generated: '2026-09-26'