# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Atlassian The Jira Cloud platform REST Workflow Scheme…
  version: 1.0.0
extends: openapi/atlassian-workflow-scheme-drafts-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      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 from an active workflow scheme
      effect: write
      questions:
      - How do I start editing an active Jira workflow scheme without affecting projects yet?
      - Can an active workflow scheme have more than one draft?
      instructions:
      - text: Create a draft copy of active workflow scheme {id}.
        slots:
          id: path.id
      - text: Start a draft of workflow scheme {id} so I can edit it safely.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- 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 does the pending draft of an active workflow scheme currently contain?
      - Is there an unpublished draft for this workflow scheme?
      instructions:
      - text: Get the draft for workflow scheme {id}.
        slots:
          id: path.id
      - text: Show me the unpublished changes in workflow scheme {id}'s draft.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/workflowscheme/{id}/draft'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a workflow scheme draft
      effect: write
      questions:
      - Can I change the name, description or issue type mappings of a workflow scheme draft in one call?
      - What happens if I update a draft that doesn't exist yet?
      instructions:
      - text: Rename the draft of workflow scheme {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Replace the issue type mappings in workflow scheme {id}'s draft with {issueTypeMappings}.
        slots:
          id: path.id
          issueTypeMappings: requestBody.issueTypeMappings
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/workflowscheme/{id}/draft'].delete
  update:
    x-apievangelist-phrasing:
      intent: Discard a workflow scheme draft
      effect: destructive
      questions:
      - How do I throw away unpublished changes to a workflow scheme?
      - Can I delete a draft workflow scheme and keep the active one as is?
      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-10-01'
- target: $.paths['/rest/api/3/workflowscheme/{id}/draft/default'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the default workflow in a scheme draft
      effect: read
      questions:
      - Which workflow will unmapped issue types use in the draft scheme?
      - What's the default workflow set in a workflow scheme's draft?
      instructions:
      - text: Get the default workflow of workflow scheme {id}'s draft.
        slots:
          id: path.id
      - text: Show which workflow the draft of scheme {id} uses for unmapped issue types.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/workflowscheme/{id}/draft/default'].put
  update:
    x-apievangelist-phrasing:
      intent: Set the default workflow in a scheme draft
      effect: write
      questions:
      - How do I change the fallback workflow in a draft workflow scheme?
      - Can I set the draft's default workflow and create the draft if needed?
      instructions:
      - text: Set the default workflow of workflow scheme {id}'s draft to {workflow}.
        slots:
          id: path.id
          workflow: requestBody.workflow
      - text: 'Make {workflow} the draft default for scheme {id}, creating the draft if needed: {updateDraftIfNeeded}.'
        slots:
          workflow: requestBody.workflow
          id: path.id
          updateDraftIfNeeded: requestBody.updateDraftIfNeeded
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/workflowscheme/{id}/draft/default'].delete
  update:
    x-apievangelist-phrasing:
      intent: Reset a scheme draft's default to Jira workflow
      effect: destructive
      questions:
      - Can I revert the draft scheme's default workflow back to Jira's system workflow?
      - What does resetting the default workflow on a draft do?
      instructions:
      - text: Reset the default workflow of workflow scheme {id}'s draft to the system jira workflow.
        slots:
          id: path.id
      - text: Clear the custom draft default workflow on scheme {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/workflowscheme/{id}/draft/issuetype/{issueType}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the draft workflow for an issue type
      effect: read
      questions:
      - Which workflow is a given issue type mapped to in the draft scheme?
      - In the draft workflow scheme, what workflow do Bugs use?
      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 the draft mapping for issue type {issueType} in workflow scheme {id}.
        slots:
          issueType: path.issueType
          id: path.id
      method: generated
      generated: '2026-10-01'
- 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 point one issue type at a different workflow in the draft scheme?
      - Can I assign Stories their own workflow in a workflow scheme draft?
      instructions:
      - text: Map issue type {issueType} to workflow {workflow} in the draft of scheme {id}.
        slots:
          issueType: path.issueType
          workflow: requestBody.workflow
          id: path.id
      - text: In workflow scheme {id}'s draft, set issue type {issueType} to use {workflow}.
        slots:
          id: path.id
          issueType: path.issueType
          workflow: requestBody.workflow
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/workflowscheme/{id}/draft/issuetype/{issueType}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unmap an issue type in a scheme draft
      effect: destructive
      questions:
      - Can I remove an issue type's specific workflow mapping from the draft scheme?
      - What happens to an issue type once its draft mapping is deleted?
      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-10-01'
- target: $.paths['/rest/api/3/workflowscheme/{id}/draft/publish'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish a workflow scheme draft
      effect: write
      questions:
      - How do I make my draft workflow scheme live for its projects?
      - Can I validate a draft publish 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 workflow scheme {id}'s draft using status mappings {statusMappings}.
        slots:
          id: path.id
          statusMappings: requestBody.statusMappings
      - text: Dry-run publishing the draft of scheme {id} with validateOnly {validateOnly}.
        slots:
          id: path.id
          validateOnly: query.validateOnly
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/workflowscheme/{id}/draft/workflow'].get
  update:
    x-apievangelist-phrasing:
      intent: List workflow-issue type mappings in a draft
      effect: read
      questions:
      - Which issue types does each workflow cover in the draft scheme?
      - Can I see the draft's mappings for just one workflow by name?
      instructions:
      - text: List the workflow to issue type mappings in the draft of scheme {id}.
        slots:
          id: path.id
      - text: Show which issue types use workflow {workflowName} in scheme {id}'s draft.
        slots:
          workflowName: query.workflowName
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/workflowscheme/{id}/draft/workflow'].put
  update:
    x-apievangelist-phrasing:
      intent: Set issue types for a workflow in a draft
      effect: write
      questions:
      - How do I assign several issue types to one workflow in a draft scheme at once?
      - Can I make a workflow the draft's default while mapping its issue types?
      instructions:
      - text: Assign issue types {issueTypes} to workflow {workflowName} in the draft of scheme {id}.
        slots:
          issueTypes: requestBody.issueTypes
          workflowName: query.workflowName
          id: path.id
      - text: 'Make {workflowName} the default in scheme {id}''s draft: {defaultMapping}.'
        slots:
          workflowName: query.workflowName
          id: path.id
          defaultMapping: requestBody.defaultMapping
      method: generated
      generated: '2026-10-01'
- 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:
      - Can I drop a whole workflow and its issue types from a draft workflow scheme?
      - How do I unassign every issue type from one workflow in 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: Delete the draft mappings for workflow {workflowName} in scheme {id}.
        slots:
          workflowName: query.workflowName
          id: path.id
      method: generated
      generated: '2026-10-01'