API Evangelist conversational phrasing for Confluence Cloud REST API v2 Descendants API

# 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 API v2 Descendants API
  version: 1.0.0
extends: openapi/confluence-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['/whiteboards/{id}/descendants'].get
  update:
    x-apievangelist-phrasing:
      intent: List all descendants of a whiteboard
      effect: read
      questions:
      - What content is nested anywhere beneath a whiteboard?
      - Can I limit how many levels deep whiteboard descendants go?
      instructions:
      - text: List every descendant of whiteboard {id}.
        slots:
          id: path.id
      - text: List descendants of whiteboard {id} down to depth {depth}.
        slots:
          id: path.id
          depth: query.depth
      method: generated
      generated: '2026-10-01'
- target: $.paths['/databases/{id}/descendants'].get
  update:
    x-apievangelist-phrasing:
      intent: List all descendants of a database
      effect: read
      questions:
      - Which items sit at any level underneath a database in the content tree?
      - Are database descendants returned top to bottom?
      instructions:
      - text: List every descendant of database {id}.
        slots:
          id: path.id
      - text: List descendants of database {id} down to depth {depth}.
        slots:
          id: path.id
          depth: query.depth
      method: generated
      generated: '2026-10-01'
- target: $.paths['/embeds/{id}/descendants'].get
  update:
    x-apievangelist-phrasing:
      intent: List all descendants of a Smart Link
      effect: read
      questions:
      - What content is nested at any depth under a Smart Link?
      - Can I restrict Smart Link descendants to a set number of levels?
      instructions:
      - text: List every descendant of Smart Link {id}.
        slots:
          id: path.id
      - text: List descendants of Smart Link {id} down to depth {depth}.
        slots:
          id: path.id
          depth: query.depth
      method: generated
      generated: '2026-10-01'
- target: $.paths['/folders/{id}/descendants'].get
  update:
    x-apievangelist-phrasing:
      intent: List all descendants of a folder
      effect: read
      questions:
      - How do I see everything inside a folder, including nested subfolders?
      - Can I cap how deep a folder's descendant listing goes?
      instructions:
      - text: List every descendant of folder {id}.
        slots:
          id: path.id
      - text: List descendants of folder {id} down to depth {depth}.
        slots:
          id: path.id
          depth: query.depth
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pages/{id}/descendants'].get
  update:
    x-apievangelist-phrasing:
      intent: List all descendants of a page
      effect: read
      questions:
      - Which pages and items are nested at any level below a page?
      - Can I get a page's whole subtree in top-to-bottom order?
      instructions:
      - text: List every descendant of page {id}.
        slots:
          id: path.id
      - text: List descendants of page {id} down to depth {depth}.
        slots:
          id: path.id
          depth: query.depth
      method: generated
      generated: '2026-10-01'