Atlassian · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/atlassian-status-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 6

$.info
$.paths['/rest/api/3/statuses'].get
$.paths['/rest/api/3/statuses'].put
$.paths['/rest/api/3/statuses'].post
$.paths['/rest/api/3/statuses'].delete
$.paths['/rest/api/3/statuses/search'].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 Status API
  version: 1.0.0
extends: openapi/atlassian-status-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: 5
- target: $.paths['/rest/api/3/statuses'].get
  update:
    x-apievangelist-phrasing:
      intent: Get workflow statuses by id
      effect: read
      questions:
      - How do I look up several Jira statuses when I have their ids?
      - Can I see which projects use a status along with its details?
      instructions:
      - text: Get statuses with ids {id}.
        slots:
          id: query.id
      - text: Fetch status {id} expanded with {expand}.
        slots:
          id: query.id
          expand: query.expand
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/statuses'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk update statuses
      effect: write
      questions:
      - How do I rename or recategorize several Jira statuses at once?
      - Can I change a status's description in bulk?
      instructions:
      - text: Update these statuses {statuses}.
        slots:
          statuses: requestBody.statuses
      - text: Apply my status name and category changes {statuses}.
        slots:
          statuses: requestBody.statuses
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/statuses'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk create statuses
      effect: write
      questions:
      - How do I add new workflow statuses to a project or globally?
      - Can I create several statuses in one request?
      instructions:
      - text: Create statuses {statuses} in scope {scope}.
        slots:
          statuses: requestBody.statuses
          scope: requestBody.scope
      - text: Add new statuses {statuses} for project scope {scope}.
        slots:
          statuses: requestBody.statuses
          scope: requestBody.scope
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/statuses'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete statuses
      effect: destructive
      questions:
      - How do I delete Jira statuses I no longer need?
      - Can I remove several statuses by id in a single call?
      instructions:
      - text: Delete statuses {id}.
        slots:
          id: query.id
      - text: Remove the workflow statuses with ids {id}.
        slots:
          id: query.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/statuses/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search statuses by name or project
      effect: read
      questions:
      - How do I find statuses whose name contains a word?
      - Can I list only the done-category statuses for one project?
      instructions:
      - text: Search statuses named like {searchString}.
        slots:
          searchString: query.searchString
      - text: List {statusCategory} statuses in project {projectId}.
        slots:
          statusCategory: query.statusCategory
          projectId: query.projectId
      method: generated
      generated: '2026-10-01'