Confluence · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluence Cloud REST Content - macro body API

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

$.info
$.paths['/wiki/rest/api/content/{id}/history/{version}/macro/id/{macroId}'].get
$.paths['/wiki/rest/api/content/{id}/history/{version}/macro/id/{macroId}/convert/{to}'].get
$.paths['/wiki/rest/api/content/{id}/history/{version}/macro/id/{macroId}/convert/async/{to}'].get

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 - macro body API
  version: 1.0.0
extends: openapi/confluence-content-macro-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: 3
- target: $.paths['/wiki/rest/api/content/{id}/history/{version}/macro/id/{macroId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a macro's body in storage format
      effect: read
      questions:
      - How can I read the raw storage-format body and parameters of a macro on a page?
      - What does a macro's definition look like in a specific page version?
      instructions:
      - text: Get macro {macroId} from version {version} of content {id} in storage format.
        slots:
          macroId: path.macroId
          version: path.version
          id: path.id
      - text: Show the name, body and parameters of macro {macroId} on content {id} version {version}.
        slots:
          macroId: path.macroId
          id: path.id
          version: path.version
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/history/{version}/macro/id/{macroId}/convert/{to}'].get
  update:
    x-apievangelist-phrasing:
      intent: Convert a macro body to another format now
      effect: read
      questions:
      - Can I get a macro rendered as view HTML instead of storage format in a single call?
      - Which representations can a macro body be converted into synchronously?
      instructions:
      - text: Convert macro {macroId} on content {id} version {version} to {to} and return it immediately.
        slots:
          macroId: path.macroId
          id: path.id
          version: path.version
          to: path.to
      - text: Render macro {macroId} from content {id} version {version} as {to} in space context {spaceKeyContext}.
        slots:
          macroId: path.macroId
          id: path.id
          version: path.version
          to: path.to
          spaceKeyContext: query.spaceKeyContext
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/history/{version}/macro/id/{macroId}/convert/async/{to}'].get
  update:
    x-apievangelist-phrasing:
      intent: Start an async conversion of a macro body
      effect: read
      questions:
      - How do I convert a large macro in the background and fetch the result later?
      - How long is an asynchronously converted macro body kept available?
      instructions:
      - text: Queue an async conversion of macro {macroId} on content {id} version {version} to {to}.
        slots:
          macroId: path.macroId
          id: path.id
          version: path.version
          to: path.to
      - text: Get an async task id for converting macro {macroId} from content {id} version {version} into {to}, allowing cached results {allowCache}.
        slots:
          macroId: path.macroId
          id: path.id
          version: path.version
          to: path.to
          allowCache: query.allowCache
      method: generated
      generated: '2026-10-01'