Confluence · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluence Cloud REST API v2 Task API

4 actions 4 updates phrasing extends openapi/confluence-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 4

$.info

$.paths['/tasks'].get

$.paths['/tasks/{id}'].get

$.paths['/tasks/{id}'].put

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 Confluence Cloud REST API v2 Task API
  version: 1.0.0
extends: openapi/confluence-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: 3
- target: $.paths['/tasks'].get
  update:
    x-apievangelist-phrasing:
      intent: List tasks
      effect: read
      questions:
      - What tasks are assigned to me across Confluence?
      - Can I find incomplete tasks on a specific page?
      - Which tasks are due within a date range?
      instructions:
      - text: List tasks assigned to {assignee} with status {status}.
        slots:
          assignee: query.assigned-to
          status: query.status
      - text: Show tasks on page {page} due between {from} and {to}.
        slots:
          page: query.page-id
          from: query.due-at-from
          to: query.due-at-to
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tasks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a task
      effect: read
      questions:
      - How do I look up a single task by its ID?
      - Who is a specific task assigned to and when is it due?
      instructions:
      - text: Get task {id}.
        slots:
          id: path.id
      - text: Show the details of task {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tasks/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Mark a task complete or incomplete
      effect: write
      questions:
      - How do I tick off a task?
      - Can I change anything besides a task's status?
      instructions:
      - text: Set task {id} to {status}.
        slots:
          id: path.id
          status: requestBody.status
      - text: Mark task {id} as {status}.
        slots:
          id: path.id
          status: requestBody.status
      method: generated
      generated: '2026-10-01'