Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian The Confluence Cloud REST Content - Attachments…

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

$.info
$.paths['/wiki/rest/api/content/{id}/child/attachment'].get
$.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 Atlassian The Confluence Cloud REST Content - Attachments…
  version: 1.0.0
extends: openapi/atlassian-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: 6
- target: $.paths['/wiki/rest/api/content/{id}/child/attachment'].get
  update:
    x-apievangelist-phrasing:
      intent: List attachments on a Confluence page
      effect: read
      questions:
      - What files are attached to a Confluence page?
      - Can I filter a page's attachments by filename or media type?
      instructions:
      - text: List the attachments on Confluence content {id}.
        slots:
          id: path.id
      - text: Find attachments on page {id} named {filename}.
        slots:
          id: path.id
          filename: query.filename
      - text: Show {mediaType} attachments on content {id}.
        slots:
          mediaType: query.mediaType
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/child/attachment'].put
  update:
    x-apievangelist-phrasing:
      intent: Upload or replace a page attachment
      effect: write
      questions:
      - How do I upload a file to a Confluence page, replacing it if it already exists?
      - Can re-uploading an attachment create a new version instead of failing?
      instructions:
      - text: Upload {file} to Confluence content {id}, creating a new version if it exists.
        slots:
          file: requestBody.file
          id: path.id
      - text: Attach or update {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: Add a new attachment to a page
      effect: write
      questions:
      - Can I attach a brand-new file to a Confluence page without overwriting existing ones?
      - Which call only adds attachments and fails if one already exists?
      instructions:
      - text: Add new attachment {file} to Confluence content {id}.
        slots:
          file: requestBody.file
          id: path.id
      - text: Attach {file} as a new file on page {id}, minor edit {minorEdit}.
        slots:
          file: requestBody.file
          id: path.id
          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:
      - Can I rename an attachment or change its media type without re-uploading it?
      - Is it possible to move an attachment to a different page?
      instructions:
      - text: Rename attachment {attachmentId} on content {id} to {title}, 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}.
        slots:
          attachmentId: path.attachmentId
          id: path.id
          container: requestBody.container
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/content/{id}/child/attachment/{attachmentId}/data'].post
  update:
    x-apievangelist-phrasing:
      intent: Replace an attachment's file contents
      effect: write
      questions:
      - How do I upload a new version of an existing attachment by its ID?
      - Can I replace just the binary data of one attachment?
      instructions:
      - text: Replace the data of attachment {attachmentId} on content {id} with {file}.
        slots:
          attachmentId: path.attachmentId
          id: path.id
          file: requestBody.file
      - text: Upload {file} as a new version of attachment {attachmentId}, minor edit {minorEdit}.
        slots:
          file: requestBody.file
          attachmentId: path.attachmentId
          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 a page attachment
      effect: read
      questions:
      - Where can I download the file behind a Confluence attachment?
      - Can I download an older version of an attachment?
      instructions:
      - text: Download attachment {attachmentId} from Confluence content {id}.
        slots:
          attachmentId: path.attachmentId
          id: path.id
      - text: Get version {version} of attachment {attachmentId} on page {id}.
        slots:
          version: query.version
          attachmentId: path.attachmentId
          id: path.id
      method: generated
      generated: '2026-10-01'