Confluence · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Confluence Page API
10 actions
10 updates
phrasing
extends
openapi/confluence-page-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.
What the actions change
x-apievangelist-phrasing
Targets 10
$.info
$.paths['/pages'].get
$.paths['/pages'].post
$.paths['/pages/{id}'].get
$.paths['/pages/{id}'].put
$.paths['/pages/{id}'].delete
$.paths['/pages/{id}/children'].get
$.paths['/spaces/{id}/pages'].get
$.paths['/labels/{id}/pages'].get
$.paths['/pages/{id}/title'].put
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 Page API
version: 1.0.0
extends: openapi/confluence-page-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: 9
- target: $.paths['/pages'].get
update:
x-apievangelist-phrasing:
intent: List pages across the site
effect: read
questions:
- How do I list all pages on my Confluence site?
- Can I find pages across spaces by their exact title?
- Which pages are currently in draft or archived status?
instructions:
- text: List pages titled {title}.
slots:
title: query.title
- text: Get all pages with status {status} across spaces {spaces}.
slots:
status: query.status
spaces: query.space-id
method: generated
generated: '2026-10-01'
- target: $.paths['/pages'].post
update:
x-apievangelist-phrasing:
intent: Create a page
effect: write
questions:
- How do I create a new Confluence page in a space?
- Can I create a page as a child of an existing page?
- Is it possible to create a page as a draft first?
instructions:
- text: 'Create a page titled {title} in space {spaceId} with {status} status and this content: {body}.'
slots:
title: requestBody.title
spaceId: requestBody.spaceId
status: requestBody.status
body: requestBody.body
- text: Add a {status} page {title} under parent page {parentId} in space {spaceId} with body {body}.
slots:
title: requestBody.title
parentId: requestBody.parentId
spaceId: requestBody.spaceId
status: requestBody.status
body: requestBody.body
method: generated
generated: '2026-10-01'
- target: $.paths['/pages/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a page
effect: read
questions:
- How do I fetch a single page with its content?
- Can I read an older version or the draft of a specific page?
instructions:
- text: Get page {id}.
slots:
id: path.id
- text: Fetch page {id} at version {version} with its body in {format}.
slots:
id: path.id
version: query.version
format: query.body-format
method: generated
generated: '2026-10-01'
- target: $.paths['/pages/{id}'].put
update:
x-apievangelist-phrasing:
intent: Update a page's content
effect: write
questions:
- How do I edit the body of an existing page?
- What version number do I need to send when updating a page?
instructions:
- text: Update page {id} to version {version} with title {title}, status {status} and body {body}.
slots:
id: path.id
version: requestBody.version
title: requestBody.title
status: requestBody.status
body: requestBody.body
- text: Rewrite the content of page {id} as {body}, saving it as version {version} titled {title} with status {status}.
slots:
id: path.id
body: requestBody.body
version: requestBody.version
title: requestBody.title
status: requestBody.status
method: generated
generated: '2026-10-01'
- target: $.paths['/pages/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a page
effect: destructive
questions:
- What happens when I delete a page — does it go to the trash?
- Can I permanently purge a page instead of trashing it?
instructions:
- text: Delete page {id}.
slots:
id: path.id
- text: Permanently purge page {id} from the trash.
slots:
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/pages/{id}/children'].get
update:
x-apievangelist-phrasing:
intent: List a page's direct child pages
effect: read
questions:
- Which pages sit directly under a given page?
- Can I get a page's children in their page-tree order?
instructions:
- text: List the child pages of page {id}.
slots:
id: path.id
- text: Show the first {limit} direct children of page {id}.
slots:
id: path.id
limit: query.limit
method: generated
generated: '2026-10-01'
- target: $.paths['/spaces/{id}/pages'].get
update:
x-apievangelist-phrasing:
intent: List the pages in a space
effect: read
questions:
- What pages does a particular space contain?
- Can I list only the root-level pages of a space?
instructions:
- text: List all pages in space {id}.
slots:
id: path.id
- text: Show the {depth} pages in space {id}.
slots:
id: path.id
depth: query.depth
method: generated
generated: '2026-10-01'
- target: $.paths['/labels/{id}/pages'].get
update:
x-apievangelist-phrasing:
intent: List pages with a label
effect: read
questions:
- Which pages have been tagged with a particular label?
- Can I narrow labelled pages to certain spaces?
instructions:
- text: List pages tagged with label {id}.
slots:
id: path.id
- text: Find pages carrying label {id} in spaces {spaces}.
slots:
id: path.id
spaces: query.space-id
method: generated
generated: '2026-10-01'
- target: $.paths['/pages/{id}/title'].put
update:
x-apievangelist-phrasing:
intent: Rename a page
effect: write
questions:
- How do I rename a page without changing its content?
- Can I change just the title of a draft page?
instructions:
- text: Rename page {id} to {title}.
slots:
id: path.id
title: requestBody.title
- text: Change the title of the {status} page {id} to {title}.
slots:
id: path.id
title: requestBody.title
status: requestBody.status
method: generated
generated: '2026-10-01'