Confluence · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluence Cloud REST Content body API

5 actions 5 updates phrasing extends openapi/confluence-content-body-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 5

$.info
$.paths['/wiki/rest/api/contentbody/convert/async/{to}'].post
$.paths['/wiki/rest/api/contentbody/convert/async/{id}'].get
$.paths['/wiki/rest/api/contentbody/convert/async/bulk/tasks'].get
$.paths['/wiki/rest/api/contentbody/convert/async/bulk/tasks'].post

OpenAPI Overlay

Raw ↑
# 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 Content body API
  version: 1.0.0
extends: openapi/confluence-content-body-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/contentbody/convert/async/{to}'].post
  update:
    x-apievangelist-phrasing:
      intent: Start converting a content body to another format
      effect: write
      questions:
      - How do I convert storage format into a rendered view in the background?
      - Which formats can a content body be converted into?
      instructions:
      - text: 'Convert this {representation} body to {to}: {value}.'
        slots:
          representation: requestBody.representation
          to: path.to
          value: requestBody.value
      - text: Start an async conversion of {value} from {representation} to {to} in space {spaceKey}.
        slots:
          value: requestBody.value
          representation: requestBody.representation
          to: path.to
          spaceKey: query.spaceKeyContext
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/contentbody/convert/async/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the result of a body conversion task
      effect: read
      questions:
      - Is my content body conversion finished yet?
      - Can I fetch the converted body once the task completes?
      instructions:
      - text: Get the result of conversion task {id}.
        slots:
          id: path.id
      - text: Check the status of async conversion {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/contentbody/convert/async/bulk/tasks'].get
  update:
    x-apievangelist-phrasing:
      intent: Get results of several body conversion tasks
      effect: read
      questions:
      - Can I check many conversion tasks at once?
      - What's the status of a batch of content body conversions?
      instructions:
      - text: Get the results of conversion tasks {ids}.
        slots:
          ids: query.ids
      - text: 'Check the status of these async conversions in bulk: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/contentbody/convert/async/bulk/tasks'].post
  update:
    x-apievangelist-phrasing:
      intent: Start bulk content body conversions
      effect: write
      questions:
      - How do I convert several content bodies in one request?
      - What's the limit on conversions per bulk request?
      instructions:
      - text: 'Start bulk conversions for these inputs: {conversionInputs}.'
        slots:
          conversionInputs: requestBody.conversionInputs
      - text: 'Queue a batch of content body conversions: {conversionInputs}.'
        slots:
          conversionInputs: requestBody.conversionInputs
      method: generated
      generated: '2026-10-01'