Confluence · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluence Cloud REST Content - attachments API

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

$.info
$.paths['/wiki/rest/api/content/{id}/child/attachment'].put
$.paths['/wiki/rest/api/content/{id}/child/attachment'].post
$.paths['/wiki/rest/api/content/{id}/child/attachment/{attachmentId}'].put
$.paths['/wiki/rest/api/content/{id}/child/attachment/{attachmentId}/data'].post
$.paths['/wiki/rest/api/content/{id}/child/attachment/{attachmentId}/download'].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 - attachments API
  version: 1.0.0
extends: openapi/confluence-content-attachments-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: 5
- target: $.paths['/wiki/rest/api/content/{id}/child/attachment'].put
  update:
    x-apievangelist-phrasing:
      intent: Upload a file, replacing it if it already exists
      effect: write
      questions:
      - How do I upload a file to a page and have it create a new version if one with that name already exists?
      - Can I upsert an attachment as a minor edit so watchers aren't notified?
      instructions:
      - text: Upload {file} to content {id}, creating a new version if it already exists, with minor edit {minorEdit}.
        slots:
          file: requestBody.file
          id: path.id
          minorEdit: requestBody.minorEdit
      - text: Upsert attachment {file} on page {id} with comment {comment}, minor edit {minorEdit}.
        slots:
          file: requestBody.file
          id: path.id
          comment: requestBody.comment
          minorEdit: requestBody.minorEdit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/child/attachment'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach a new file to a page
      effect: write
      questions:
      - How do I add a brand-new attachment to a Confluence page without touching existing ones?
      - Why does my upload need the X-Atlassian-Token nocheck header?
      instructions:
      - text: Attach new file {file} to content {id}, minor edit {minorEdit}.
        slots:
          file: requestBody.file
          id: path.id
          minorEdit: requestBody.minorEdit
      - text: Add {file} as a new attachment on page {id} with comment {comment}, minor edit {minorEdit}.
        slots:
          file: requestBody.file
          id: path.id
          comment: requestBody.comment
          minorEdit: requestBody.minorEdit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/child/attachment/{attachmentId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or move an attachment
      effect: write
      questions:
      - How do I rename an attachment or change its media type without re-uploading it?
      - Can I move an attachment to a different parent page?
      instructions:
      - text: Rename attachment {attachmentId} on content {id} to {title}, as version {version}.
        slots:
          attachmentId: path.attachmentId
          id: path.id
          title: requestBody.title
          version: requestBody.version
      - text: Move attachment {attachmentId} from content {id} to container {container}, type {type}, body id {attachmentBodyId}, version {version}.
        slots:
          attachmentId: path.attachmentId
          id: path.id
          container: requestBody.container
          type: requestBody.type
          attachmentBodyId: requestBody.id
          version: requestBody.version
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/child/attachment/{attachmentId}/data'].post
  update:
    x-apievangelist-phrasing:
      intent: Replace the file contents of an attachment
      effect: write
      questions:
      - How do I upload a new version of an existing attachment by its ID?
      - Can I replace an attachment's binary data and leave a comment on the change?
      instructions:
      - text: Replace the data of attachment {attachmentId} on content {id} with {file}, minor edit {minorEdit}.
        slots:
          attachmentId: path.attachmentId
          id: path.id
          file: requestBody.file
          minorEdit: requestBody.minorEdit
      - text: Upload {file} as the new binary for attachment {attachmentId} on page {id} with comment {comment}, minor edit {minorEdit}.
        slots:
          file: requestBody.file
          attachmentId: path.attachmentId
          id: path.id
          comment: requestBody.comment
          minorEdit: requestBody.minorEdit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/child/attachment/{attachmentId}/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download an attachment
      effect: read
      questions:
      - How do I download a file attached to a Confluence page?
      - Can I download an older version of an attachment?
      instructions:
      - text: Download attachment {attachmentId} from content {id}.
        slots:
          attachmentId: path.attachmentId
          id: path.id
      - text: Get the download link for version {version} of attachment {attachmentId} on page {id}.
        slots:
          version: query.version
          attachmentId: path.attachmentId
          id: path.id
      method: generated
      generated: '2026-10-01'