API Evangelist conversational phrasing for Jira Cloud platform REST Workflow scheme drafts API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Jira Cloud platform REST Workflow scheme drafts API
  version: 1.0.0
extends: openapi/jira-workflow-scheme-drafts-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: 14
- target: $.paths['/rest/api/3/workflowscheme/{id}/createdraft'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a draft copy of an active workflow scheme
      effect: write
      questions:
      - How do I start a draft of an active workflow scheme so I can edit it safely?
      - Can an active workflow scheme have more than one draft?
      instructions:
      - text: Create a draft from active workflow scheme {id}.
        slots:
          id: path.id
      - text: Copy workflow scheme {id} into a new draft for editing.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/workflowscheme/{id}/draft'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the draft of a workflow scheme
      effect: read
      questions:
      - What pending changes are in the draft of an active workflow scheme?
      - Does a given workflow scheme currently have a draft?
      instructions:
      - text: Get the draft for workflow scheme {id}.
        slots:
          id: path.id
      - text: Show the unpublished draft of workflow scheme {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/workflowscheme/{id}/draft'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a draft workflow scheme
      effect: write
      questions:
      - How do I rename or re-describe the draft of a workflow scheme?
      - Will updating a draft create one if the scheme has no draft yet?
      instructions:
      - text: Rename the draft of workflow scheme {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Set the draft of workflow scheme {id} to default workflow {defaultWorkflow} with mappings {issueTypeMappings}.
        slots:
          id: path.id
          defaultWorkflow: requestBody.defaultWorkflow
          issueTypeMappings: requestBody.issueTypeMappings
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/workflowscheme/{id}/draft'].delete
  update:
    x-apievangelist-phrasing:
      intent: Discard a draft workflow scheme
      effect: destructive
      questions:
      - How do I throw away unpublished changes to a workflow scheme?
      - Can I delete a workflow scheme's draft without touching the active scheme?
      instructions:
      - text: Delete the draft of workflow scheme {id}.
        slots:
          id: path.id
      - text: Discard all pending draft changes on workflow scheme {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/workflowscheme/{id}/draft/default'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the default workflow in a scheme's draft
      effect: read
      questions:
      - Which workflow handles unmapped issue types in a draft workflow scheme?
      - What is the default workflow set in my scheme's draft?
      instructions:
      - text: Get the default workflow of the draft for workflow scheme {id}.
        slots:
          id: path.id
      - text: Show which workflow covers all unassigned issue types in scheme {id}'s draft.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/workflowscheme/{id}/draft/default'].put
  update:
    x-apievangelist-phrasing:
      intent: Set the default workflow in a scheme's draft
      effect: write
      questions:
      - How do I change the default workflow in a draft workflow scheme?
      - Can setting the draft's default workflow create the draft automatically?
      instructions:
      - text: Set {workflow} as the default workflow in the draft of scheme {id}.
        slots:
          workflow: requestBody.workflow
          id: path.id
      - text: Make {workflow} the fallback for unmapped issue types in workflow scheme {id}'s draft.
        slots:
          workflow: requestBody.workflow
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/workflowscheme/{id}/draft/default'].delete
  update:
    x-apievangelist-phrasing:
      intent: Reset a draft's default workflow to the system one
      effect: destructive
      questions:
      - How do I reset a draft scheme's default workflow back to Jira's system workflow?
      - What becomes the default workflow if I clear it in a draft?
      instructions:
      - text: Reset the default workflow in the draft of scheme {id} to the system workflow.
        slots:
          id: path.id
      - text: Clear the custom default workflow from workflow scheme {id}'s draft.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/workflowscheme/{id}/draft/issuetype/{issueType}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the workflow for an issue type in a draft
      effect: read
      questions:
      - Which workflow is a specific issue type mapped to in a draft workflow scheme?
      - In the draft scheme, what workflow will bugs follow?
      instructions:
      - text: Get the workflow mapped to issue type {issueType} in the draft of scheme {id}.
        slots:
          issueType: path.issueType
          id: path.id
      - text: Show which draft workflow issue type {issueType} uses in workflow scheme {id}.
        slots:
          issueType: path.issueType
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/workflowscheme/{id}/draft/issuetype/{issueType}'].put
  update:
    x-apievangelist-phrasing:
      intent: Map an issue type to a workflow in a draft
      effect: write
      questions:
      - How do I assign a different workflow to one issue type in a draft scheme?
      - Can I change a single issue type's workflow without publishing yet?
      instructions:
      - text: In the draft of scheme {id}, map issue type {issueType} to workflow {workflow}.
        slots:
          id: path.id
          issueType: path.issueType
          workflow: requestBody.workflow
      - text: Set draft workflow {workflow} for issue type {issueType} on workflow scheme {id}.
        slots:
          workflow: requestBody.workflow
          issueType: path.issueType
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/workflowscheme/{id}/draft/issuetype/{issueType}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an issue type's mapping from a draft
      effect: destructive
      questions:
      - How do I unmap one issue type from its workflow in a draft scheme?
      - What happens to an issue type after I remove its draft workflow mapping?
      instructions:
      - text: Remove the workflow mapping for issue type {issueType} from the draft of scheme {id}.
        slots:
          issueType: path.issueType
          id: path.id
      - text: Unmap issue type {issueType} in workflow scheme {id}'s draft.
        slots:
          issueType: path.issueType
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/workflowscheme/{id}/draft/publish'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish a draft workflow scheme
      effect: write
      questions:
      - How do I make my draft workflow scheme changes live?
      - Can I validate a draft publish first without applying it?
      - What happens to issues whose status doesn't exist in the new workflow?
      instructions:
      - text: Publish the draft of workflow scheme {id}.
        slots:
          id: path.id
      - text: Publish scheme {id}'s draft, moving issues with status mappings {statusMappings}.
        slots:
          id: path.id
          statusMappings: requestBody.statusMappings
      - text: 'Only validate publishing the draft of scheme {id}: validateOnly {validateOnly}.'
        slots:
          id: path.id
          validateOnly: query.validateOnly
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/workflowscheme/{id}/draft/workflow'].get
  update:
    x-apievangelist-phrasing:
      intent: List workflow-to-issue-type mappings in a draft
      effect: read
      questions:
      - Which issue types does each workflow cover in a draft scheme?
      - Can I limit draft mappings to just one workflow by name?
      instructions:
      - text: List all workflow to issue type mappings in the draft of scheme {id}.
        slots:
          id: path.id
      - text: Show which issue types workflow {workflowName} covers in scheme {id}'s draft.
        slots:
          workflowName: query.workflowName
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/workflowscheme/{id}/draft/workflow'].put
  update:
    x-apievangelist-phrasing:
      intent: Set the issue types for a workflow in a draft
      effect: write
      questions:
      - How do I assign a list of issue types to one workflow in a draft scheme?
      - Can I make a workflow the draft default while setting its issue types?
      instructions:
      - text: In the draft of scheme {id}, assign issue types {issueTypes} to workflow {workflowName}.
        slots:
          id: path.id
          issueTypes: requestBody.issueTypes
          workflowName: query.workflowName
      - text: 'Make workflow {workflowName} the default in scheme {id}''s draft: defaultMapping {defaultMapping}.'
        slots:
          workflowName: query.workflowName
          id: path.id
          defaultMapping: requestBody.defaultMapping
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/workflowscheme/{id}/draft/workflow'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a workflow's mappings from a draft
      effect: destructive
      questions:
      - How do I drop a whole workflow from a draft workflow scheme?
      - Where do issue types go when I remove their workflow from the draft?
      instructions:
      - text: Remove workflow {workflowName} and its issue type mappings from the draft of scheme {id}.
        slots:
          workflowName: query.workflowName
          id: path.id
      - text: Drop workflow {workflowName} from workflow scheme {id}'s draft.
        slots:
          workflowName: query.workflowName
          id: path.id
      method: generated
      generated: '2026-09-26'