# 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 Step Field Maps API
  version: 1.0.0
extends: openapi/optimizely-job-definition-step-field-maps-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: 9
- target: $.paths['/api/v1/admin/JobDefinitionStepFieldMaps'].get
  update:
    x-apievangelist-phrasing:
      intent: List integration job field mappings
      effect: read
      questions:
      - Which field mappings are defined on integration job steps in Optimizely Commerce?
      - Can I filter field maps to one job definition step?
      instructions:
      - text: List all job step field mappings.
      - text: Show field maps matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/JobDefinitionStepFieldMaps'].post
  update:
    x-apievangelist-phrasing:
      intent: Map a source field to a target in a job step
      effect: write
      questions:
      - How do I map an ERP column to a Commerce property in an integration job step?
      - Can I decide what happens when a lookup fails or a value is empty?
      instructions:
      - text: Map {fromProperty} to {toProperty} as a {fieldType} field in step {jobDefinitionStepId}.
        slots:
          fromProperty: requestBody.fromProperty
          toProperty: requestBody.toProperty
          fieldType: requestBody.fieldType
          jobDefinitionStepId: requestBody.jobDefinitionStepId
      - text: Map {fieldType} {fromProperty} to {toProperty}; on lookup error {lookupErrorHandling}, on empty {emptyValueHandling}.
        slots:
          fieldType: requestBody.fieldType
          fromProperty: requestBody.fromProperty
          toProperty: requestBody.toProperty
          lookupErrorHandling: requestBody.lookupErrorHandling
          emptyValueHandling: requestBody.emptyValueHandling
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/JobDefinitionStepFieldMaps({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one job step field mapping
      effect: read
      questions:
      - What source and target properties does a given field map connect?
      - Can I look up a single field mapping by id?
      instructions:
      - text: Fetch field map {id}.
        slots:
          id: path.id
      - text: Show the from and to properties of field mapping {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/JobDefinitionStepFieldMaps({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a job step field mapping
      effect: write
      questions:
      - Can I overwrite an entire field mapping definition?
      - Does replacing a field map require resending its handling rules?
      instructions:
      - text: Replace field map {id} to map {fromProperty} onto {toProperty}.
        slots:
          id: path.id
          fromProperty: requestBody.fromProperty
          toProperty: requestBody.toProperty
      - text: Overwrite the full definition of field mapping {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/JobDefinitionStepFieldMaps({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one job step field mapping
      effect: destructive
      questions:
      - How do I drop a single field mapping from a job step?
      - Can deleting a field map be guarded by its ETag?
      instructions:
      - text: Delete field map {id}.
        slots:
          id: path.id
      - text: Delete field mapping {id} only if its ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/JobDefinitionStepFieldMaps({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Tweak a job step field mapping
      effect: write
      questions:
      - Can I mark an existing field map as the ERP key?
      - Is it possible to stop a mapping from overwriting existing values?
      instructions:
      - text: Set the ERP key flag on field map {id} to {isErpKey}.
        slots:
          id: path.id
          isErpKey: requestBody.isErpKey
      - text: Set overwrite to {overwrite} on field mapping {id}.
        slots:
          id: path.id
          overwrite: requestBody.overwrite
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/JobDefinitionStepFieldMaps/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for a field mapping
      effect: read
      questions:
      - What defaults does a new job step field map start with?
      - Is there a blank field mapping template?
      instructions:
      - text: Get the default field values for a new job step field map.
      - text: Show the empty field mapping template.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/jobdefinitionstepfieldmaps/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete job step field mappings
      effect: destructive
      questions:
      - Can I remove many field mappings in one request?
      - Is there a batch delete for job step field maps by id list?
      instructions:
      - text: Bulk delete field maps {ids}.
        slots:
          ids: query.ids
      - text: Permanently delete every field mapping in {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/jobdefinitionstepfieldmaps({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a field mapping
      effect: read
      questions:
      - How can I read a custom property stored on a job step field map?
      - Can I fetch one custom field value from a field mapping record?
      instructions:
      - text: Get custom property {custompropertyKey} of field map {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      - text: Show the {custompropertyKey} custom property on field mapping {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'