API Evangelist conversational phrasing for Atlassian The Jira Cloud platform REST Workflows API

# 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 Workflows API
  version: 1.0.0
extends: openapi/atlassian-workflows-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: 10
- target: $.paths['/rest/api/3/workflow'].get
  update:
    x-apievangelist-phrasing:
      intent: List all workflows (deprecated endpoint)
      effect: read
      questions:
      - Is there an older call that returns every Jira workflow in one unpaginated array?
      - Can I fetch a single workflow by name from the deprecated all-workflows endpoint?
      instructions:
      - text: List every workflow using the deprecated unpaginated endpoint.
      - text: Get workflow {workflowName} from the legacy all-workflows call.
        slots:
          workflowName: query.workflowName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/workflow'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a single company-managed workflow
      effect: write
      questions:
      - How do I create one Jira workflow with its statuses and transitions?
      - What happens if I create a workflow without any transition rules?
      instructions:
      - text: Create a workflow named {name} with statuses {statuses} and transitions {transitions}.
        slots:
          name: requestBody.name
          statuses: requestBody.statuses
          transitions: requestBody.transitions
      - text: Create a single workflow called {name} described as {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/workflow/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search published classic workflows
      effect: read
      questions:
      - How do I page through the published classic workflows in Jira?
      - Can I find only active workflows whose name contains some text?
      instructions:
      - text: Search workflows matching {queryString}.
        slots:
          queryString: query.queryString
      - text: List published workflows where active is {isActive}, ordered by {orderBy}.
        slots:
          isActive: query.isActive
          orderBy: query.orderBy
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/workflow/{entityId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an inactive workflow
      effect: destructive
      questions:
      - How do I delete a Jira workflow that's no longer used?
      - Why can't I delete a workflow that is still in a workflow scheme?
      instructions:
      - text: Delete inactive workflow {entityId}.
        slots:
          entityId: path.entityId
      - text: Remove the unused workflow {entityId}.
        slots:
          entityId: path.entityId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/workflows'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk get workflows and their statuses
      effect: read
      questions:
      - How do I fetch several workflows and their statuses at once by id or name?
      - Can I look up the workflow used by a particular project and issue type?
      instructions:
      - text: Get workflows with ids {workflowIds} and their statuses.
        slots:
          workflowIds: requestBody.workflowIds
      - text: Fetch the workflows for project and issue type pairs {projectAndIssueTypes}.
        slots:
          projectAndIssueTypes: requestBody.projectAndIssueTypes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/workflows/capabilities'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the rules and capabilities a workflow supports
      effect: read
      questions:
      - What transition rules and capabilities are available for a given workflow?
      - Is this workflow scoped globally or to a project?
      instructions:
      - text: Show the capabilities of workflow {workflowId}.
        slots:
          workflowId: query.workflowId
      - text: Get workflow capabilities for project {projectId} and issue type {issueTypeId}.
        slots:
          projectId: query.projectId
          issueTypeId: query.issueTypeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/workflows/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk create workflows and statuses
      effect: write
      questions:
      - How do I create several workflows and their statuses in one request?
      - Can I create project-scoped workflows in bulk?
      instructions:
      - text: Create workflows {workflows} with statuses {statuses} in scope {scope}.
        slots:
          workflows: requestBody.workflows
          statuses: requestBody.statuses
          scope: requestBody.scope
      - text: Bulk create the workflows {workflows} at {scope} scope.
        slots:
          workflows: requestBody.workflows
          scope: requestBody.scope
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/workflows/create/validation'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a bulk workflow create payload
      effect: read
      questions:
      - Can I check a bulk workflow creation payload for errors before submitting it?
      - How do I dry-run creating new workflows?
      instructions:
      - text: Validate this workflow create payload {payload}.
        slots:
          payload: requestBody.payload
      - text: Check new-workflow payload {payload} with options {validationOptions}.
        slots:
          payload: requestBody.payload
          validationOptions: requestBody.validationOptions
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/workflows/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk update workflows and statuses
      effect: write
      questions:
      - How do I update several existing workflows and their statuses at once?
      - Can I change workflow transitions for many workflows in one call?
      instructions:
      - text: Update workflows {workflows} with statuses {statuses}.
        slots:
          workflows: requestBody.workflows
          statuses: requestBody.statuses
      - text: Apply my edits to existing workflows {workflows}.
        slots:
          workflows: requestBody.workflows
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/workflows/update/validation'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a bulk workflow update payload
      effect: read
      questions:
      - Can I validate workflow edits before applying them?
      - How do I dry-run a bulk update to existing workflows?
      instructions:
      - text: Validate this workflow update payload {payload}.
        slots:
          payload: requestBody.payload
      - text: Check the update payload {payload} for existing workflows using options {validationOptions}.
        slots:
          payload: requestBody.payload
          validationOptions: requestBody.validationOptions
      method: generated
      generated: '2026-10-01'