# 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 Parameters API
  version: 1.0.0
extends: openapi/optimizely-job-definition-parameters-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/JobDefinitionParameters'].get
  update:
    x-apievangelist-phrasing:
      intent: List job definition parameters
      effect: read
      questions:
      - Which parameters are defined for my integration job definitions?
      - Can I filter job parameters to a single job definition?
      instructions:
      - text: List all job definition parameters.
      - text: List job parameters matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/JobDefinitionParameters'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a parameter to a job definition
      effect: write
      questions:
      - How do I add an input parameter to an integration job definition?
      - What value type, prompt and default does a new job parameter need?
      instructions:
      - text: Add parameter {name} to job definition {jobDefinitionId} with default {defaultValue}.
        slots:
          name: requestBody.name
          jobDefinitionId: requestBody.jobDefinitionId
          defaultValue: requestBody.defaultValue
      - text: Create job parameter {name} of type {valueType} prompting {prompt}.
        slots:
          name: requestBody.name
          valueType: requestBody.valueType
          prompt: requestBody.prompt
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/JobDefinitionParameters({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a job definition parameter
      effect: read
      questions:
      - What default value and prompt does a given job parameter have?
      - Can I look up one job definition parameter by id?
      instructions:
      - text: Get job definition parameter {id}.
        slots:
          id: path.id
      - text: Fetch job parameter {id} returning only {select}.
        slots:
          id: path.id
          select: query.$select
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/JobDefinitionParameters({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a job definition parameter
      effect: write
      questions:
      - How do I overwrite a job parameter's whole definition?
      - Can I resend name, type, prompt and default to replace a job parameter?
      instructions:
      - text: Replace job parameter {id} with name {name} and type {valueType}.
        slots:
          id: path.id
          name: requestBody.name
          valueType: requestBody.valueType
      - text: Overwrite the full job parameter record {id} with prompt {prompt}.
        slots:
          id: path.id
          prompt: requestBody.prompt
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/JobDefinitionParameters({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one job definition parameter
      effect: destructive
      questions:
      - How do I remove a parameter from a job definition?
      - Can deleting a job parameter use an If-Match ETag?
      instructions:
      - text: Delete job definition parameter {id}.
        slots:
          id: path.id
      - text: Delete job parameter {id} only if its ETag still matches {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/JobDefinitionParameters({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a job parameter's default or order
      effect: write
      questions:
      - Can I change only the default value of a job parameter?
      - How do I reorder a job parameter's sequence?
      instructions:
      - text: Set the default of job parameter {id} to {defaultValue}.
        slots:
          id: path.id
          defaultValue: requestBody.defaultValue
      - text: Move job parameter {id} to sequence {sequence}.
        slots:
          id: path.id
          sequence: requestBody.sequence
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/JobDefinitionParameters/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for a new job parameter
      effect: read
      questions:
      - What defaults does a new job definition parameter start with?
      - Is there a blank job parameter template?
      instructions:
      - text: Get the default template for a job definition parameter.
      - text: Fetch an empty job parameter with default values.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/jobdefinitionparameters/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete job definition parameters
      effect: destructive
      questions:
      - Can I remove many job parameters in one call?
      - How do I bulk-delete job definition parameters by id?
      instructions:
      - text: Bulk delete job definition parameters {ids}.
        slots:
          ids: query.ids
      - text: Permanently remove every job parameter in {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/jobdefinitionparameters({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a job parameter
      effect: read
      questions:
      - What custom property values are stored on a job definition parameter?
      - Can I read one custom attribute of a job parameter?
      instructions:
      - text: Get custom property {custompropertyKey} on job parameter {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      - text: Read extra attribute {custompropertyKey} of job definition parameter {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'