Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian The Jira Cloud platform REST Workflow Transition…

4 actions 4 updates phrasing extends openapi/atlassian-workflow-transition-rules-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Atlassian's API. It is a proposal applied on top of the contract, not a document Atlassian publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/rest/api/3/workflow/rule/config'].get

$.paths['/rest/api/3/workflow/rule/config'].put

$.paths['/rest/api/3/workflow/rule/config/delete'].put

OpenAPI Overlay

# 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 Transition…
  version: 1.0.0
extends: openapi/atlassian-workflow-transition-rules-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: 3
- target: $.paths['/rest/api/3/workflow/rule/config'].get
  update:
    x-apievangelist-phrasing:
      intent: List workflows with transition rules
      effect: read
      questions:
      - Which workflows use my app's post functions or validators on transitions?
      - Can I filter transition rules by rule type and workflow name?
      instructions:
      - text: List workflows with transition rules of types {types}.
        slots:
          types: query.types
      - text: Show {types} transition rules in workflows {workflowNames}.
        slots:
          types: query.types
          workflowNames: query.workflowNames
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/workflow/rule/config'].put
  update:
    x-apievangelist-phrasing:
      intent: Update transition rule configurations
      effect: write
      questions:
      - How do I change the configuration of my app's conditions or post functions on a workflow?
      - Can I update transition rules across several workflows in one request?
      instructions:
      - text: Update the transition rule configurations in {workflows}.
        slots:
          workflows: requestBody.workflows
      - text: Apply new post function and validator settings to workflows {workflows}.
        slots:
          workflows: requestBody.workflows
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/workflow/rule/config/delete'].put
  update:
    x-apievangelist-phrasing:
      intent: Delete transition rules from workflows
      effect: destructive
      questions:
      - How do I remove my app's transition rules from workflows?
      - Can I delete post functions from several workflows in one call?
      instructions:
      - text: Delete the transition rules listed in {workflows}.
        slots:
          workflows: requestBody.workflows
      - text: Strip these conditions and post functions out of workflows {workflows}.
        slots:
          workflows: requestBody.workflows
      method: generated
      generated: '2026-10-01'