Confluence · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluence Cloud REST Long-running task API

3 actions 3 updates phrasing extends openapi/confluence-long-running-task-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Confluence's API. It is a proposal applied on top of the contract, not a document Confluence 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

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Confluence Cloud REST Long-running task API
  version: 1.0.0
extends: openapi/confluence-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 active long-running tasks
      effect: read
      questions:
      - Which long-running jobs, like space exports, are running on my site right now?
      - How far along is each active background task?
      instructions:
      - text: List all active long-running tasks.
      - text: Show {limit} running background tasks starting at {start}.
        slots:
          limit: query.limit
          start: query.start
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/longtask/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check progress of a long-running task
      effect: read
      questions:
      - What percentage of my space export has completed?
      - How long has a specific background task been running?
      instructions:
      - text: Get the status of long-running task {id}.
        slots:
          id: path.id
      - text: Check how far task {id} has progressed.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'