Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian The Confluence Cloud REST Content - Macro Body API

4 actions 4 updates phrasing extends openapi/atlassian-content-macro-body-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 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 Atlassian The Confluence Cloud REST Content - Macro Body API
  version: 1.0.0
extends: openapi/atlassian-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 my app read a Confluence macro's body and parameters?
      - What format does the raw macro body come back in?
      instructions:
      - text: Get macro {macroId} from content {id} at version {version}.
        slots:
          macroId: path.macroId
          id: path.id
          version: path.version
      - text: Read the storage-format body of macro {macroId} in page {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: Get a macro body converted to another format
      effect: read
      questions:
      - Can I get a macro's body rendered as view HTML right away?
      - Which representation can a macro body be converted to synchronously?
      instructions:
      - text: Convert macro {macroId} in content {id} version {version} to {to} now.
        slots:
          macroId: path.macroId
          id: path.id
          version: path.version
          to: path.to
      - text: Return macro {macroId} from page {id} at version {version} synchronously as {to}.
        slots:
          macroId: path.macroId
          id: path.id
          version: path.version
          to: path.to
      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 macro body conversion
      effect: read
      questions:
      - Can I convert a large macro body in the background and fetch it later?
      - How long is an asynchronous macro conversion result kept?
      instructions:
      - text: Start an async conversion of macro {macroId} in content {id} version {version} to {to}.
        slots:
          macroId: path.macroId
          id: path.id
          version: path.version
          to: path.to
      - text: Queue macro {macroId} from page {id} version {version} for background conversion to {to}.
        slots:
          macroId: path.macroId
          id: path.id
          version: path.version
          to: path.to
      method: generated
      generated: '2026-10-01'