# 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 Parameters API version: 1.0.0 extends: openapi/optimizely-job-definition-step-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/JobDefinitionStepParameters'].get update: x-apievangelist-phrasing: intent: List integration job step parameters effect: read questions: - Which parameters are defined on my integration job steps in Optimizely Configured Commerce? - Can I filter step parameters to one job definition step and sort by sequence? instructions: - text: List all job definition step parameters. - text: List job step parameters matching {filter}, ordered by {orderby}. slots: filter: query.$filter orderby: query.$orderby method: generated generated: '2026-09-26' - target: $.paths['/api/v1/admin/JobDefinitionStepParameters'].post update: x-apievangelist-phrasing: intent: Add a parameter to a job definition step effect: write questions: - How do I add a prompted parameter with a default value to an integration job step? - What value types and prompts are needed for a new step parameter? instructions: - text: Add parameter {name} of type {valueType} with default {defaultValue} and prompt {prompt}. slots: name: requestBody.name valueType: requestBody.valueType defaultValue: requestBody.defaultValue prompt: requestBody.prompt - text: Create a step parameter on job step {jobDefinitionStepId} at sequence {sequence}. slots: jobDefinitionStepId: requestBody.jobDefinitionStepId sequence: requestBody.sequence method: generated generated: '2026-09-26' - target: $.paths['/api/v1/admin/JobDefinitionStepParameters({id})'].get update: x-apievangelist-phrasing: intent: Get one job step parameter effect: read questions: - How do I look up a single job step parameter's default value by ID? - Can I expand the parent step when fetching one step parameter? instructions: - text: Show job definition step parameter {id}. slots: id: path.id - text: Fetch step parameter {id} with {expand} expanded. slots: id: path.id expand: query.$expand method: generated generated: '2026-09-26' - target: $.paths['/api/v1/admin/JobDefinitionStepParameters({id})'].put update: x-apievangelist-phrasing: intent: Replace a job step parameter effect: write questions: - Can I overwrite a job step parameter with a complete new definition? - What happens to step parameter fields I omit on a full replace? instructions: - text: Replace step parameter {id} with name {name}, type {valueType} and default {defaultValue}. slots: id: path.id name: requestBody.name valueType: requestBody.valueType defaultValue: requestBody.defaultValue - text: Overwrite the whole job step parameter {id}, setting its prompt to {prompt}. slots: id: path.id prompt: requestBody.prompt method: generated generated: '2026-09-26' - target: $.paths['/api/v1/admin/JobDefinitionStepParameters({id})'].delete update: x-apievangelist-phrasing: intent: Delete a job step parameter effect: destructive questions: - How do I remove one parameter from an integration job step? - Can I make deleting a step parameter conditional on an ETag? instructions: - text: Delete job step parameter {id}. slots: id: path.id - text: Delete step parameter {id} only if its ETag matches {etag}. slots: id: path.id etag: header.If-Match method: generated generated: '2026-09-26' - target: $.paths['/api/v1/admin/JobDefinitionStepParameters({id})'].patch update: x-apievangelist-phrasing: intent: Update a job step parameter effect: write questions: - Can I change just the default value of a job step parameter? - How would I reorder a parameter within its job step? instructions: - text: Patch step parameter {id} so its default value is {defaultValue}. slots: id: path.id defaultValue: requestBody.defaultValue - text: Move job step parameter {id} to sequence {sequence}. slots: id: path.id sequence: requestBody.sequence method: generated generated: '2026-09-26' - target: $.paths['/api/v1/admin/JobDefinitionStepParameters/Default.Default()'].get update: x-apievangelist-phrasing: intent: Get default values for a job step parameter effect: read questions: - What defaults does the admin pre-fill for a new job step parameter? - Where do I get a blank step parameter template? instructions: - text: Get the default job step parameter template. - text: Show me the pre-filled defaults for a new step parameter. method: generated generated: '2026-09-26' - target: $.paths['/api/v1/admin/jobdefinitionstepparameters/delete'].delete update: x-apievangelist-phrasing: intent: Bulk delete job step parameters effect: destructive questions: - How do I delete several job step parameters in one request? - Can I bulk-remove step parameters by ID? instructions: - text: Bulk delete job step parameters {ids}. slots: ids: query.ids - text: Permanently remove the step parameters with IDs {ids}. slots: ids: query.ids method: generated generated: '2026-09-26' - target: $.paths['/api/v1/admin/jobdefinitionstepparameters({key})/customproperties({custompropertyKey})'].get update: x-apievangelist-phrasing: intent: Get a custom property on a job step parameter effect: read questions: - How can I read one custom property stored on a job step parameter? - Can I select fields from a step parameter's custom property? instructions: - text: Show custom property {custompropertyKey} on job step parameter {key}. slots: custompropertyKey: path.custompropertyKey key: path.key - text: Fetch step parameter {key}'s custom property {custompropertyKey}, selecting {select}. slots: key: path.key custompropertyKey: path.custompropertyKey select: query.$select method: generated generated: '2026-09-26'