Confluence · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluence Cloud REST Experimental API

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

$.info
$.paths['/wiki/rest/api/content/{id}/pageTree'].delete
$.paths['/wiki/rest/api/space/{spaceKey}/label'].get
$.paths['/wiki/rest/api/space/{spaceKey}/label'].post
$.paths['/wiki/rest/api/space/{spaceKey}/label'].delete

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 Experimental API
  version: 1.0.0
extends: openapi/confluence-experimental-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: 4
- target: $.paths['/wiki/rest/api/content/{id}/pageTree'].delete
  update:
    x-apievangelist-phrasing:
      intent: Trash a page and all its descendants
      effect: destructive
      questions:
      - How do I move a whole page tree, including every child page, to the trash?
      - Does the page-tree delete work on drafts or only current pages?
      instructions:
      - text: Move page {id} and all its descendants to the trash.
        slots:
          id: path.id
      - text: Trash the entire page tree rooted at {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/space/{spaceKey}/label'].get
  update:
    x-apievangelist-phrasing:
      intent: List a space's labels by space key
      effect: read
      questions:
      - How do I see the labels on a space when I only know its key?
      - Can I filter a space's labels by prefix such as team or my?
      instructions:
      - text: List the labels on space key {spaceKey}.
        slots:
          spaceKey: path.spaceKey
      - text: Show {prefix} labels for space key {spaceKey}.
        slots:
          prefix: query.prefix
          spaceKey: path.spaceKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/space/{spaceKey}/label'].post
  update:
    x-apievangelist-phrasing:
      intent: Add labels to a space
      effect: write
      questions:
      - How do I tag a space with new labels without removing its existing ones?
      - Can I categorise a space by attaching labels to it?
      instructions:
      - text: Add labels to space {spaceKey}.
        slots:
          spaceKey: path.spaceKey
      - text: Tag space {spaceKey} with additional labels, keeping the current ones.
        slots:
          spaceKey: path.spaceKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/space/{spaceKey}/label'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a label from a space
      effect: destructive
      questions:
      - How do I untag a space?
      - Do I need the label's prefix to remove it from a space?
      instructions:
      - text: Remove label {name} from space {spaceKey}.
        slots:
          name: query.name
          spaceKey: path.spaceKey
      - text: Delete the {prefix} label {name} from space {spaceKey}.
        slots:
          prefix: query.prefix
          name: query.name
          spaceKey: path.spaceKey
      method: generated
      generated: '2026-10-01'