# 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 Job Definition Steps API
  version: 1.0.0
extends: openapi/optimizely-job-definition-steps-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/JobDefinitionSteps'].get
  update:
    x-apievangelist-phrasing:
      intent: List integration job steps
      effect: read
      questions:
      - Which steps make up my integration job definitions?
      - Can I filter job definition steps by job and sort them by sequence?
      instructions:
      - text: List all job definition steps.
      - text: List job definition steps matching {filter}, ordered by {orderby}.
        slots:
          filter: query.$filter
          orderby: query.$orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/JobDefinitionSteps'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a step to an integration job
      effect: write
      questions:
      - How do I add a new step to an integration job definition?
      - What select, from and where clauses does a new job step need?
      instructions:
      - text: Add step {name} for object {objectName} to job definition {jobDefinitionId}.
        slots:
          name: requestBody.name
          objectName: requestBody.objectName
          jobDefinitionId: requestBody.jobDefinitionId
      - text: Create job step {name} selecting {selectClause} from {fromClause} where {whereClause}.
        slots:
          name: requestBody.name
          selectClause: requestBody.selectClause
          fromClause: requestBody.fromClause
          whereClause: requestBody.whereClause
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/JobDefinitionSteps({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an integration job step
      effect: read
      questions:
      - How do I see the query and delete action configured on one job step?
      - What object does a specific job definition step process?
      instructions:
      - text: Get job definition step {id}.
        slots:
          id: path.id
      - text: Show the clauses of job step {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/JobDefinitionSteps({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an integration job step
      effect: write
      questions:
      - How do I overwrite a whole job definition step in one call?
      - Does replacing a job step require every clause again?
      instructions:
      - text: Replace job step {id} with name {name}, object {objectName} and where clause {whereClause}.
        slots:
          id: path.id
          name: requestBody.name
          objectName: requestBody.objectName
          whereClause: requestBody.whereClause
      - text: Fully overwrite job definition step {id} with delete action {deleteAction}.
        slots:
          id: path.id
          deleteAction: requestBody.deleteAction
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/JobDefinitionSteps({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an integration job step
      effect: destructive
      questions:
      - How do I remove one step from an integration job?
      - Can I delete a job step only if its ETag still matches?
      instructions:
      - text: Delete job definition step {id}.
        slots:
          id: path.id
      - text: Delete job step {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/JobDefinitionSteps({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an integration job step
      effect: write
      questions:
      - How do I change the sequence of a job step?
      - Can I switch a job step to only update existing records?
      instructions:
      - text: Move job step {id} to sequence {sequence}.
        slots:
          id: path.id
          sequence: requestBody.sequence
      - text: Set only-update-existing-records to {onlyUpdateExistingRecords} on job step {id}.
        slots:
          onlyUpdateExistingRecords: requestBody.onlyUpdateExistingRecords
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/JobDefinitionSteps/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the default job step template
      effect: read
      questions:
      - What default values does a new job definition step start with?
      - Where can I get a blank job step record?
      instructions:
      - text: Get the default job definition step template.
      - text: Show default values for a new job step.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/jobdefinitionsteps/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete job steps
      effect: destructive
      questions:
      - How do I delete several job definition steps at once?
      - Can I remove a batch of job steps by their ids?
      instructions:
      - text: Delete job definition steps {ids}.
        slots:
          ids: query.ids
      - text: Bulk remove job steps with ids {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/jobdefinitionsteps({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a job step custom property
      effect: read
      questions:
      - How do I read a custom property stored on a job definition step?
      - Where is one custom property value for a job step?
      instructions:
      - text: Get custom property {custompropertyKey} of job step {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show job step {key}'s custom property {custompropertyKey}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/jobdefinitionsteps({key})/jobdefinitionstepfieldmaps({jobdefinitionstepfieldmapKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a job step field mapping
      effect: read
      questions:
      - How do I see how one source field maps to a target field in a job step?
      - Can I fetch a single field map on an integration job step?
      instructions:
      - text: Get field map {fieldMapKey} of job step {key}.
        slots:
          fieldMapKey: path.jobdefinitionstepfieldmapKey
          key: path.key
      - text: Show field mapping {fieldMapKey} on job definition step {key}.
        slots:
          fieldMapKey: path.jobdefinitionstepfieldmapKey
          key: path.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/jobdefinitionsteps({key})/jobdefinitionstepparameters({jobdefinitionstepparameterKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a job step parameter
      effect: read
      questions:
      - How do I read one parameter passed to an integration job step?
      - Can I fetch a single parameter on a job definition step?
      instructions:
      - text: Get parameter {parameterKey} of job step {key}.
        slots:
          parameterKey: path.jobdefinitionstepparameterKey
          key: path.key
      - text: Show job definition step {key}'s parameter {parameterKey}.
        slots:
          parameterKey: path.jobdefinitionstepparameterKey
          key: path.key
      method: generated
      generated: '2026-09-26'