Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian The Confluence Cloud REST Content - Children and…

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

$.info
$.paths['/wiki/rest/api/content/{id}/child'].get
$.paths['/wiki/rest/api/content/{pageId}/move/{position}/{targetId}'].put
$.paths['/wiki/rest/api/content/{id}/child/{type}'].get
$.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 Atlassian The Confluence Cloud REST Content - Children and…
  version: 1.0.0
extends: openapi/atlassian-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: 7
- target: $.paths['/wiki/rest/api/content/{id}/child'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a page's direct children by type (legacy)
      effect: read
      questions:
      - 'What sits directly under a Confluence page: child pages, comments and attachments?'
      - Can I get a map of a page's immediate children of every type at once?
      instructions:
      - text: Get the direct children of content {id}, grouped by type.
        slots:
          id: path.id
      - text: Show the immediate child pages and comments of {id} with {expand} expanded.
        slots:
          id: path.id
          expand: query.expand
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{pageId}/move/{position}/{targetId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Move a Confluence page relative to another page
      effect: write
      questions:
      - How do I move a Confluence page under a different parent page?
      - Can I reorder a page so it sits before or after a sibling?
      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 {targetId} using position {position}.
        slots:
          pageId: path.pageId
          targetId: path.targetId
          position: path.position
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/child/{type}'].get
  update:
    x-apievangelist-phrasing:
      intent: List a page's direct children of one type
      effect: read
      questions:
      - Which pages are immediate children of a given Confluence page?
      - Can I list only the attachments directly on a page, with paging?
      instructions:
      - text: List the direct {type} children of content {id}.
        slots:
          type: path.type
          id: path.id
      - text: Get {limit} immediate {type} children of page {id}.
        slots:
          limit: query.limit
          type: path.type
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/descendant'].get
  update:
    x-apievangelist-phrasing:
      intent: Get all descendants of a page, every level
      effect: read
      questions:
      - How do I get every page nested anywhere below a Confluence page, not just direct children?
      - Can I see all descendant comments and attachments under a page tree?
      instructions:
      - text: Get all descendants of content {id} at every level.
        slots:
          id: path.id
      - text: Show the full nested tree below page {id} with {expand} expanded.
        slots:
          id: path.id
          expand: query.expand
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/descendant/{type}'].get
  update:
    x-apievangelist-phrasing:
      intent: List descendants of one type under a page
      effect: read
      questions:
      - Can I list every nested child page under a page down to all levels?
      - Is there a depth option when listing descendant pages of one type?
      instructions:
      - text: List all {type} descendants of content {id}.
        slots:
          type: path.type
          id: path.id
      - text: Get {type} descendants of page {id} with depth {depth}.
        slots:
          type: path.type
          id: path.id
          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 its whole subtree
      effect: write
      questions:
      - How do I duplicate a Confluence page together with all its child pages?
      - Can I copy a page tree including attachments, labels and permissions?
      instructions:
      - text: Copy the page hierarchy under {id} to parent page {destinationPageId}.
        slots:
          id: path.id
          destinationPageId: requestBody.destinationPageId
      - text: 'Copy page {id} and its descendants to {destinationPageId}, copying attachments: {copyAttachments}.'
        slots:
          id: path.id
          destinationPageId: requestBody.destinationPageId
          copyAttachments: requestBody.copyAttachments
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/copy'].post
  update:
    x-apievangelist-phrasing:
      intent: Copy a single Confluence page
      effect: write
      questions:
      - How do I make a copy of just one Confluence page without its children?
      - Can I give the copied page a new title when duplicating it?
      instructions:
      - text: Copy page {id} to {destination}.
        slots:
          id: path.id
          destination: requestBody.destination
      - text: Duplicate the single page {id} to {destination} titled {pageTitle}.
        slots:
          id: path.id
          destination: requestBody.destination
          pageTitle: requestBody.pageTitle
      method: generated
      generated: '2026-10-01'