Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian The Confluence Cloud REST Inline Tasks API

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

$.info

$.paths['/wiki/rest/api/inlinetasks/search'].get

$.paths['/wiki/rest/api/inlinetasks/{inlineTaskId}'].get

$.paths['/wiki/rest/api/inlinetasks/{inlineTaskId}'].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 Atlassian The Confluence Cloud REST Inline Tasks API
  version: 1.0.0
extends: openapi/atlassian-inline-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: 3
- target: $.paths['/wiki/rest/api/inlinetasks/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search Confluence inline tasks
      effect: read
      questions:
      - Which Confluence tasks are assigned to me and still incomplete?
      - Can I find inline tasks due within a date range in one space?
      - What tasks were completed on a particular page?
      instructions:
      - text: Find inline tasks assigned to {assignee} with status {status}.
        slots:
          assignee: query.assignee
          status: query.status
      - text: List tasks in space {spaceKey} due between {duedateFrom} and {duedateTo}.
        slots:
          spaceKey: query.spaceKey
          duedateFrom: query.duedateFrom
          duedateTo: query.duedateTo
      - text: Show inline tasks on page {pageId}.
        slots:
          pageId: query.pageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/inlinetasks/{inlineTaskId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Confluence inline task
      effect: read
      questions:
      - Can I look up one inline task by its global ID?
      - Who is assigned to a specific Confluence task and when is it due?
      instructions:
      - text: Get inline task {inlineTaskId}.
        slots:
          inlineTaskId: path.inlineTaskId
      - text: Show the assignee and due date of task {inlineTaskId}.
        slots:
          inlineTaskId: path.inlineTaskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/inlinetasks/{inlineTaskId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Complete or reopen a Confluence inline task
      effect: write
      questions:
      - How do I mark a Confluence task as complete?
      - Can I reopen an inline task that was ticked off?
      instructions:
      - text: Set inline task {inlineTaskId} to {status}.
        slots:
          inlineTaskId: path.inlineTaskId
          status: requestBody.status
      - text: Mark Confluence task {inlineTaskId} as complete.
        slots:
          inlineTaskId: path.inlineTaskId
      method: generated
      generated: '2026-10-01'