Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian The Confluence Cloud REST Long-Running Task API

3 actions 3 updates phrasing extends openapi/atlassian-long-running-task-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['/wiki/rest/api/longtask'].get

$.paths['/wiki/rest/api/longtask/{id}'].get

OpenAPI Overlay

# 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 Confluence Cloud REST Long-Running Task API
  version: 1.0.0
extends: openapi/atlassian-long-running-task-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['/wiki/rest/api/longtask'].get
  update:
    x-apievangelist-phrasing:
      intent: List running Confluence long tasks
      effect: read
      questions:
      - Which long-running jobs, like space exports, are running in Confluence right now?
      - Can I see how far along each active background task is?
      instructions:
      - text: List the active long-running tasks in Confluence.
      - text: Show running Confluence tasks, {limit} at a time.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/longtask/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check progress of a long task
      effect: read
      questions:
      - How far along is my space export?
      - Can I check the percentage complete of one long-running task?
      instructions:
      - text: Get the progress of long-running task {id}.
        slots:
          id: path.id
      - text: Check how long Confluence task {id} has been running.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'