Atlassian · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/atlassian-tasks-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/task/{taskId}'].get
$.paths['/rest/api/3/task/{taskId}/cancel'].post

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 Tasks API
  version: 1.0.0
extends: openapi/atlassian-tasks-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/task/{taskId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of a long-running task
      effect: read
      questions:
      - How do I check progress on a long-running Jira background task?
      - How long are finished task results kept?
      instructions:
      - text: Get the status of task {taskId}.
        slots:
          taskId: path.taskId
      - text: Check whether background task {taskId} has finished.
        slots:
          taskId: path.taskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/task/{taskId}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a long-running task
      effect: destructive
      questions:
      - How do I stop a Jira background task that's still running?
      - Who is allowed to cancel an asynchronous task?
      instructions:
      - text: Cancel task {taskId}.
        slots:
          taskId: path.taskId
      - text: Stop the running background task {taskId}.
        slots:
          taskId: path.taskId
      method: generated
      generated: '2026-10-01'