Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian The Confluence Cloud REST Experimental API

5 actions 5 updates phrasing extends openapi/atlassian-experimental-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 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 Atlassian The Confluence Cloud REST Experimental API
  version: 1.0.0
extends: openapi/atlassian-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 Confluence page and every child page under it to the trash?
      - Does trashing a page tree work on drafts or only current pages?
      instructions:
      - text: Trash page {id} along with all of its descendants.
        slots:
          id: path.id
      - text: Move the whole page tree under {id} to the space trash.
        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 labels on a space
      effect: read
      questions:
      - What labels are attached to a Confluence space?
      - Can I filter space labels by prefix such as team or global?
      instructions:
      - text: List labels on space {spaceKey}.
        slots:
          spaceKey: path.spaceKey
      - text: Show {prefix} labels on space {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 Confluence space with labels?
      - Does adding space labels keep the labels it already has?
      instructions:
      - text: Add labels to space {spaceKey}.
        slots:
          spaceKey: path.spaceKey
      - text: Tag space {spaceKey} with new labels without removing existing 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 remove a label from a Confluence space?
      - Do I need the label prefix to delete a space label?
      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'