Atlassian · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/atlassian-workflow-status-categories-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/statuscategory'].get
$.paths['/rest/api/3/statuscategory/{idOrKey}'].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 Status…
  version: 1.0.0
extends: openapi/atlassian-workflow-status-categories-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/statuscategory'].get
  update:
    x-apievangelist-phrasing:
      intent: List Jira status categories
      effect: read
      questions:
      - What status categories, like To Do, In Progress and Done, does Jira use?
      - Can I get all status categories with their colors?
      instructions:
      - text: List all Jira status categories.
      - text: Show every status category and its color.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/statuscategory/{idOrKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one status category
      effect: read
      questions:
      - Which category does a given status category key like done refer to?
      - Can I look up a status category by ID or key?
      instructions:
      - text: Get status category {idOrKey}.
        slots:
          idOrKey: path.idOrKey
      - text: Show the name and color of status category {idOrKey}.
        slots:
          idOrKey: path.idOrKey
      method: generated
      generated: '2026-10-01'