# 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 Children API
  version: 1.0.0
extends: openapi/confluence-children-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['/whiteboards/{id}/direct-children'].get
  update:
    x-apievangelist-phrasing:
      intent: List direct children of a whiteboard
      effect: read
      questions:
      - What content sits directly beneath a whiteboard in the content tree?
      - Can I sort the immediate children of a whiteboard?
      instructions:
      - text: List the direct children of whiteboard {id}.
        slots:
          id: path.id
      - text: Show the first {limit} items directly under whiteboard {id}.
        slots:
          limit: query.limit
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/databases/{id}/direct-children'].get
  update:
    x-apievangelist-phrasing:
      intent: List direct children of a database
      effect: read
      questions:
      - Which items are nested one level under a Confluence database?
      - Can I page through a database's immediate children?
      instructions:
      - text: List the direct children of database {id}.
        slots:
          id: path.id
      - text: Show the first {limit} items directly under database {id}.
        slots:
          limit: query.limit
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/embeds/{id}/direct-children'].get
  update:
    x-apievangelist-phrasing:
      intent: List direct children of a Smart Link
      effect: read
      questions:
      - What content is nested directly under a Smart Link in the page tree?
      - Can a Smart Link embed have child content I can list?
      instructions:
      - text: List the direct children of Smart Link {id}.
        slots:
          id: path.id
      - text: Show the first {limit} items directly under Smart Link {id}.
        slots:
          limit: query.limit
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/folders/{id}/direct-children'].get
  update:
    x-apievangelist-phrasing:
      intent: List direct children of a folder
      effect: read
      questions:
      - What pages and items are directly inside a folder?
      - Can I sort the contents of a folder one level deep?
      instructions:
      - text: List the direct children of folder {id}.
        slots:
          id: path.id
      - text: Show the first {limit} items directly inside folder {id}.
        slots:
          limit: query.limit
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pages/{id}/children'].get
  update:
    x-apievangelist-phrasing:
      intent: List child pages of a page
      effect: read
      questions:
      - How do I list only the child pages under a parent page?
      - Does the child pages list include whiteboards or folders, or only pages?
      instructions:
      - text: List the child pages of page {id}.
        slots:
          id: path.id
      - text: Show the sub-pages of parent page {id}, sorted by {sort}.
        slots:
          id: path.id
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom-content/{id}/children'].get
  update:
    x-apievangelist-phrasing:
      intent: List child custom content
      effect: read
      questions:
      - Which custom content items are children of another custom content item?
      - Can I paginate through child custom content?
      instructions:
      - text: List the child custom content of item {id}.
        slots:
          id: path.id
      - text: Show the first {limit} custom content children of {id}.
        slots:
          limit: query.limit
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pages/{id}/direct-children'].get
  update:
    x-apievangelist-phrasing:
      intent: List all direct children of a page
      effect: read
      questions:
      - What content of every type sits directly under a page, including folders and whiteboards?
      - Can I see a page's immediate children of any content type, not just sub-pages?
      instructions:
      - text: List every direct child of page {id}, whatever its content type.
        slots:
          id: path.id
      - text: Show the first {limit} content-tree children of page {id}.
        slots:
          limit: query.limit
          id: path.id
      method: generated
      generated: '2026-10-01'