Atlassian · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/atlassian-workflow-statuses-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 3

$.info
$.paths['/rest/api/3/status'].get
$.paths['/rest/api/3/status/{idOrName}'].get

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 Statuses API
  version: 1.0.0
extends: openapi/atlassian-workflow-statuses-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: 2
- target: $.paths['/rest/api/3/status'].get
  update:
    x-apievangelist-phrasing:
      intent: List all workflow statuses
      effect: read
      questions:
      - What statuses are used by active Jira workflows?
      - Can I get every issue status without admin permission?
      instructions:
      - text: List all statuses in active Jira workflows.
      - text: Show me every workflow status on the site.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/status/{idOrName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workflow status by ID or name
      effect: read
      questions:
      - Can I look up a status by its name instead of its ID?
      - Which status is returned when two share the same name?
      instructions:
      - text: Get status {idOrName}.
        slots:
          idOrName: path.idOrName
      - text: Show the details of workflow status {idOrName}.
        slots:
          idOrName: path.idOrName
      method: generated
      generated: '2026-10-01'