Confluence · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluence Cloud REST Content - children and descendants API

6 actions 6 updates phrasing extends openapi/confluence-content-children-and-descendants-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 6

$.info
$.paths['/wiki/rest/api/content/{pageId}/move/{position}/{targetId}'].put
$.paths['/wiki/rest/api/content/{id}/descendant'].get
$.paths['/wiki/rest/api/content/{id}/descendant/{type}'].get
$.paths['/wiki/rest/api/content/{id}/pagehierarchy/copy'].post
$.paths['/wiki/rest/api/content/{id}/copy'].post

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 Content - children and descendants API
  version: 1.0.0
extends: openapi/confluence-content-children-and-descendants-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: 5
- target: $.paths['/wiki/rest/api/content/{pageId}/move/{position}/{targetId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Move a page in the page tree
      effect: write
      questions:
      - How do I move a page under a different parent?
      - Can I reorder a page so it sits before another page?
      instructions:
      - text: Move page {pageId} {position} page {targetId}.
        slots:
          pageId: path.pageId
          position: path.position
          targetId: path.targetId
      - text: Make page {pageId} a child of page {targetId} using position {position}.
        slots:
          pageId: path.pageId
          position: path.position
          targetId: path.targetId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/descendant'].get
  update:
    x-apievangelist-phrasing:
      intent: Get all descendants of content
      effect: read
      questions:
      - What's everything nested under a page at every level?
      - Can I see a page's whole subtree, not just its direct children?
      instructions:
      - text: Get all descendants of content {id}.
        slots:
          id: path.id
      - text: Show every nested item under page {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/descendant/{type}'].get
  update:
    x-apievangelist-phrasing:
      intent: List descendants of a given type
      effect: read
      questions:
      - Which comments or attachments exist anywhere below a page?
      - Can I list only descendant pages of one type, at every depth?
      instructions:
      - text: List all {type} descendants of content {id}.
        slots:
          id: path.id
          type: path.type
      - text: Show {type} items under page {id} to depth {depth}.
        slots:
          id: path.id
          type: path.type
          depth: query.depth
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/pagehierarchy/copy'].post
  update:
    x-apievangelist-phrasing:
      intent: Copy a page and all its descendants
      effect: write
      questions:
      - How do I duplicate a whole page tree under a new parent?
      - Can I copy a page hierarchy including attachments and permissions?
      instructions:
      - text: Copy the page hierarchy under page {id} to new parent {destinationPageId}.
        slots:
          id: path.id
          destinationPageId: requestBody.destinationPageId
      - text: Duplicate page {id} and all its descendants beneath page {destinationPageId}, copying attachments too.
        slots:
          id: path.id
          destinationPageId: requestBody.destinationPageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/copy'].post
  update:
    x-apievangelist-phrasing:
      intent: Copy a single page
      effect: write
      questions:
      - How do I copy just one page, without its children?
      - Can I give the copied page a new title?
      instructions:
      - text: Copy page {id} to {destination}.
        slots:
          id: path.id
          destination: requestBody.destination
      - text: Make a single copy of page {id} at {destination} titled {pageTitle}.
        slots:
          id: path.id
          destination: requestBody.destination
          pageTitle: requestBody.pageTitle
      method: generated
      generated: '2026-10-01'