Atlassian · OpenAPI Overlay 1.0.0

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

5 actions 5 updates phrasing extends openapi/atlassian-workflow-transition-properties-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 5

$.info
$.paths['/rest/api/3/workflow/transitions/{transitionId}/properties'].get
$.paths['/rest/api/3/workflow/transitions/{transitionId}/properties'].put
$.paths['/rest/api/3/workflow/transitions/{transitionId}/properties'].post
$.paths['/rest/api/3/workflow/transitions/{transitionId}/properties'].delete

OpenAPI Overlay

Raw ↑
# 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-properties-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: 4
- target: $.paths['/rest/api/3/workflow/transitions/{transitionId}/properties'].get
  update:
    x-apievangelist-phrasing:
      intent: List the properties on a workflow transition
      effect: read
      questions:
      - What properties are set on a transition in a workflow?
      - Can I include reserved jira.-prefixed keys when reading transition properties?
      instructions:
      - text: List the properties on transition {transitionId} in workflow {workflowName}.
        slots:
          transitionId: path.transitionId
          workflowName: query.workflowName
      - text: Show the {key} property of transition {transitionId} in the {workflowMode} version of {workflowName}.
        slots:
          key: query.key
          transitionId: path.transitionId
          workflowMode: query.workflowMode
          workflowName: query.workflowName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/workflow/transitions/{transitionId}/properties'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a workflow transition property's value
      effect: write
      questions:
      - How do I change the value of an existing property on a workflow transition?
      - What happens if I update a transition property that doesn't exist yet?
      instructions:
      - text: Change property {key} on transition {transitionId} of workflow {workflowName} to {value}.
        slots:
          key: query.key
          transitionId: path.transitionId
          workflowName: query.workflowName
          value: requestBody.value
      - text: Update the existing {key} value to {value} on transition {transitionId} in the {workflowMode} {workflowName}.
        slots:
          key: query.key
          value: requestBody.value
          transitionId: path.transitionId
          workflowMode: query.workflowMode
          workflowName: query.workflowName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/workflow/transitions/{transitionId}/properties'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a property to a workflow transition
      effect: write
      questions:
      - How do I add a new property to change how a workflow transition behaves?
      - Can I add a transition property to a draft workflow?
      instructions:
      - text: Add property {key} with value {value} to transition {transitionId} in workflow {workflowName}.
        slots:
          key: query.key
          value: requestBody.value
          transitionId: path.transitionId
          workflowName: query.workflowName
      - text: Create new transition property {key}={value} on {transitionId} in the {workflowMode} {workflowName}.
        slots:
          key: query.key
          value: requestBody.value
          transitionId: path.transitionId
          workflowMode: query.workflowMode
          workflowName: query.workflowName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/workflow/transitions/{transitionId}/properties'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a property from a workflow transition
      effect: destructive
      questions:
      - How do I delete a property from a workflow transition?
      - Can I remove a transition property from a draft workflow only?
      instructions:
      - text: Delete property {key} from transition {transitionId} in workflow {workflowName}.
        slots:
          key: query.key
          transitionId: path.transitionId
          workflowName: query.workflowName
      - text: Remove {key} from transition {transitionId} in the {workflowMode} version of {workflowName}.
        slots:
          key: query.key
          transitionId: path.transitionId
          workflowMode: query.workflowMode
          workflowName: query.workflowName
      method: generated
      generated: '2026-10-01'