Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian The Confluence Cloud REST Content Versions API

5 actions 5 updates phrasing extends openapi/atlassian-content-versions-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Atlassian's API. It is a proposal applied on top of the contract, not a document Atlassian publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/wiki/rest/api/content/{id}/version'].get

$.paths['/wiki/rest/api/content/{id}/version'].post

$.paths['/wiki/rest/api/content/{id}/version/{versionNumber}'].get

$.paths['/wiki/rest/api/content/{id}/version/{versionNumber}'].delete

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 Atlassian The Confluence Cloud REST Content Versions API
  version: 1.0.0
extends: openapi/atlassian-content-versions-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: 4
- target: $.paths['/wiki/rest/api/content/{id}/version'].get
  update:
    x-apievangelist-phrasing:
      intent: List a page's version history
      effect: read
      questions:
      - What's the edit history of a Confluence page?
      - Are content versions returned newest first?
      instructions:
      - text: List the versions of content {id}.
        slots:
          id: path.id
      - text: Show the latest {limit} versions of page {id}.
        slots:
          limit: query.limit
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/version'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore an older page version
      effect: write
      questions:
      - How do I roll a Confluence page back to an earlier version?
      - Does restoring a version overwrite history or create a new version?
      instructions:
      - text: Restore content {id} using operation {operationKey} with params {params}.
        slots:
          id: path.id
          operationKey: requestBody.operationKey
          params: requestBody.params
      - text: Roll page {id} back via {operationKey} to the version given in {params}.
        slots:
          id: path.id
          operationKey: requestBody.operationKey
          params: requestBody.params
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/version/{versionNumber}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one version of a page
      effect: read
      questions:
      - Can I see who made a specific version of a page and when?
      - What details come back for a single historical page version?
      instructions:
      - text: Get version {versionNumber} of content {id}.
        slots:
          versionNumber: path.versionNumber
          id: path.id
      - text: Show details of page {id} at version {versionNumber}.
        slots:
          id: path.id
          versionNumber: path.versionNumber
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/version/{versionNumber}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a historical page version
      effect: destructive
      questions:
      - Can I delete the current version of a Confluence page?
      - What happens to the changes in a version I delete?
      instructions:
      - text: Delete version {versionNumber} of content {id}.
        slots:
          versionNumber: path.versionNumber
          id: path.id
      - text: Remove historical version {versionNumber} from page {id}.
        slots:
          versionNumber: path.versionNumber
          id: path.id
      method: generated
      generated: '2026-10-01'