Confluence · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/confluence-ancestors-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['/whiteboards/{id}/ancestors'].get

$.paths['/databases/{id}/ancestors'].get

$.paths['/embeds/{id}/ancestors'].get

$.paths['/folders/{id}/ancestors'].get

$.paths['/pages/{id}/ancestors'].get

OpenAPI Overlay

# 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 Ancestors API
  version: 1.0.0
extends: openapi/confluence-ancestors-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}/ancestors'].get
  update:
    x-apievangelist-phrasing:
      intent: List a whiteboard's ancestors
      effect: read
      questions:
      - Where does a whiteboard sit in the content tree?
      - Which pages or folders are above a given whiteboard?
      instructions:
      - text: List the ancestors of whiteboard {id}.
        slots:
          id: path.id
      - text: Show the parent chain for whiteboard {id}, top level first.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/databases/{id}/ancestors'].get
  update:
    x-apievangelist-phrasing:
      intent: List a database's ancestors
      effect: read
      questions:
      - What content sits above a Confluence database in the tree?
      - Can I get the full parent path of a database?
      instructions:
      - text: List the ancestors of database {id}.
        slots:
          id: path.id
      - text: Show the parent chain for database {id}, top level first.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/embeds/{id}/ancestors'].get
  update:
    x-apievangelist-phrasing:
      intent: List a Smart Link's ancestors
      effect: read
      questions:
      - Where is an embedded Smart Link located in the content tree?
      - Which parents does a Smart Link in the tree have?
      instructions:
      - text: List the ancestors of Smart Link {id}.
        slots:
          id: path.id
      - text: Show the parent chain for Smart Link embed {id}, top level first.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/folders/{id}/ancestors'].get
  update:
    x-apievangelist-phrasing:
      intent: List a folder's ancestors
      effect: read
      questions:
      - Which folders and pages contain a given folder?
      - Can I see the full path above a folder?
      instructions:
      - text: List the ancestors of folder {id}.
        slots:
          id: path.id
      - text: Show the parent chain for folder {id}, top level first.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pages/{id}/ancestors'].get
  update:
    x-apievangelist-phrasing:
      intent: List a page's ancestors
      effect: read
      questions:
      - What are the parent pages of a page, all the way to the top?
      - Can I build a breadcrumb trail for a page?
      instructions:
      - text: List the ancestors of page {id}.
        slots:
          id: path.id
      - text: Give me up to {limit} parent levels above page {id}.
        slots:
          id: path.id
          limit: query.limit
      method: generated
      generated: '2026-10-01'