Confluence · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Confluence Cloud REST API v2 Version API
13 actions
13 updates
phrasing
extends
openapi/confluence-version-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 13
$.info
$.paths['/attachments/{id}/versions'].get
$.paths['/attachments/{attachment-id}/versions/{version-number}'].get
$.paths['/blogposts/{id}/versions'].get
$.paths['/blogposts/{blogpost-id}/versions/{version-number}'].get
$.paths['/pages/{id}/versions'].get
$.paths['/pages/{page-id}/versions/{version-number}'].get
$.paths['/custom-content/{custom-content-id}/versions'].get
$.paths['/custom-content/{custom-content-id}/versions/{version-number}'].get
$.paths['/footer-comments/{id}/versions'].get
$.paths['/footer-comments/{id}/versions/{version-number}'].get
$.paths['/inline-comments/{id}/versions'].get
$.paths['/inline-comments/{id}/versions/{version-number}'].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 Version API
version: 1.0.0
extends: openapi/confluence-version-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: 12
- target: $.paths['/attachments/{id}/versions'].get
update:
x-apievangelist-phrasing:
intent: List an attachment's versions
effect: read
questions:
- How do I see every uploaded version of an attachment?
- Can I sort an attachment's version history newest first?
instructions:
- text: List the versions of attachment {id}.
slots:
id: path.id
- text: Show attachment {id}'s version history sorted by {sort}.
slots:
id: path.id
sort: query.sort
method: generated
generated: '2026-10-01'
- target: $.paths['/attachments/{attachment-id}/versions/{version-number}'].get
update:
x-apievangelist-phrasing:
intent: Get one version of an attachment
effect: read
questions:
- What changed in a specific version of an attachment?
- Who uploaded a particular attachment version and when?
instructions:
- text: Get version {version} of attachment {attachment}.
slots:
attachment: path.attachment-id
version: path.version-number
- text: Show the details of attachment {attachment} at version {version}.
slots:
attachment: path.attachment-id
version: path.version-number
method: generated
generated: '2026-10-01'
- target: $.paths['/blogposts/{id}/versions'].get
update:
x-apievangelist-phrasing:
intent: List a blog post's versions
effect: read
questions:
- Which edits have been made to a blog post over time?
- Can I page through a blog post's version history?
instructions:
- text: List the versions of blog post {id}.
slots:
id: path.id
- text: Show the last {limit} versions of blog post {id}.
slots:
id: path.id
limit: query.limit
method: generated
generated: '2026-10-01'
- target: $.paths['/blogposts/{blogpost-id}/versions/{version-number}'].get
update:
x-apievangelist-phrasing:
intent: Get one version of a blog post
effect: read
questions:
- Who made a specific revision to a blog post?
- Can I look at the details of an earlier blog post version?
instructions:
- text: Get version {version} of blog post {blogpost}.
slots:
blogpost: path.blogpost-id
version: path.version-number
- text: Show who edited blog post {blogpost} in version {version}.
slots:
blogpost: path.blogpost-id
version: path.version-number
method: generated
generated: '2026-10-01'
- target: $.paths['/pages/{id}/versions'].get
update:
x-apievangelist-phrasing:
intent: List a page's versions
effect: read
questions:
- How do I see the full edit history of a Confluence page?
- Can I get a page's versions with the body in a particular format?
instructions:
- text: List the versions of page {id}.
slots:
id: path.id
- text: Show page {id}'s version history with bodies in {format} format.
slots:
id: path.id
format: query.body-format
method: generated
generated: '2026-10-01'
- target: $.paths['/pages/{page-id}/versions/{version-number}'].get
update:
x-apievangelist-phrasing:
intent: Get one version of a page
effect: read
questions:
- Who made a particular revision to a page, and what was the message?
- Can I inspect an old version of a page by its number?
instructions:
- text: Get version {version} of page {page}.
slots:
page: path.page-id
version: path.version-number
- text: Show the details of page {page} at revision {version}.
slots:
page: path.page-id
version: path.version-number
method: generated
generated: '2026-10-01'
- target: $.paths['/custom-content/{custom-content-id}/versions'].get
update:
x-apievangelist-phrasing:
intent: List a custom content item's versions
effect: read
questions:
- What's the revision history of a custom content item?
- Can I page through versions of app-defined custom content?
instructions:
- text: List the versions of custom content {item}.
slots:
item: path.custom-content-id
- text: Show the latest {limit} versions of custom content {item}.
slots:
item: path.custom-content-id
limit: query.limit
method: generated
generated: '2026-10-01'
- target: $.paths['/custom-content/{custom-content-id}/versions/{version-number}'].get
update:
x-apievangelist-phrasing:
intent: Get one version of custom content
effect: read
questions:
- Who changed a custom content item in a given version?
- Can I read the details of a specific custom content revision?
instructions:
- text: Get version {version} of custom content {item}.
slots:
item: path.custom-content-id
version: path.version-number
- text: Show custom content {item} as of version {version}.
slots:
item: path.custom-content-id
version: path.version-number
method: generated
generated: '2026-10-01'
- target: $.paths['/footer-comments/{id}/versions'].get
update:
x-apievangelist-phrasing:
intent: List a footer comment's versions
effect: read
questions:
- Has a footer comment at the bottom of a page been edited?
- Can I see every revision of a footer comment?
instructions:
- text: List the versions of footer comment {id}.
slots:
id: path.id
- text: Show footer comment {id}'s edit history sorted by {sort}.
slots:
id: path.id
sort: query.sort
method: generated
generated: '2026-10-01'
- target: $.paths['/footer-comments/{id}/versions/{version-number}'].get
update:
x-apievangelist-phrasing:
intent: Get one version of a footer comment
effect: read
questions:
- What did a footer comment say in an earlier version?
- Who edited a footer comment in a particular revision?
instructions:
- text: Get version {version} of footer comment {id}.
slots:
id: path.id
version: path.version-number
- text: Show footer comment {id} as it was at version {version}.
slots:
id: path.id
version: path.version-number
method: generated
generated: '2026-10-01'
- target: $.paths['/inline-comments/{id}/versions'].get
update:
x-apievangelist-phrasing:
intent: List an inline comment's versions
effect: read
questions:
- Has an inline comment on highlighted text been edited?
- Can I list every revision of an inline comment?
instructions:
- text: List the versions of inline comment {id}.
slots:
id: path.id
- text: Show inline comment {id}'s edit history sorted by {sort}.
slots:
id: path.id
sort: query.sort
method: generated
generated: '2026-10-01'
- target: $.paths['/inline-comments/{id}/versions/{version-number}'].get
update:
x-apievangelist-phrasing:
intent: Get one version of an inline comment
effect: read
questions:
- What did an inline comment say before it was edited?
- Who changed an inline comment in a specific revision?
instructions:
- text: Get version {version} of inline comment {id}.
slots:
id: path.id
version: path.version-number
- text: Show inline comment {id} as it was at version {version}.
slots:
id: path.id
version: path.version-number
method: generated
generated: '2026-10-01'