# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Confluence Attachment API
  version: 1.0.0
extends: openapi/confluence-attachment-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: 8
- target: $.paths['/attachments/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an attachment by id
      effect: read
      questions:
      - What details can I get about a single Confluence attachment?
      - Can I look up an attachment's metadata if I only have its id?
      instructions:
      - text: Show the details of attachment {id}.
        slots:
          id: path.id
      - text: Fetch the metadata for attachment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attachments/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an attachment
      effect: destructive
      questions:
      - How do I delete a file attachment from Confluence?
      - Can I remove an attachment using only its id?
      instructions:
      - text: Delete attachment {id}.
        slots:
          id: path.id
      - text: Remove the uploaded file with attachment id {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pages/{id}/attachments'].get
  update:
    x-apievangelist-phrasing:
      intent: List attachments on a page
      effect: read
      questions:
      - Which files are attached to a specific page?
      - Can I page through a page's attachments with a cursor?
      instructions:
      - text: List the attachments on page {id}.
        slots:
          id: path.id
      - text: Show the first {limit} files attached to page {id}.
        slots:
          limit: query.limit
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attachments'].get
  update:
    x-apievangelist-phrasing:
      intent: List all attachments across the site
      effect: read
      questions:
      - How do I list every attachment on my Confluence site?
      - Can I filter site-wide attachments by media type or filename?
      - Is it possible to find attachments that are in the trash?
      instructions:
      - text: List all attachments on the site.
      - text: Find attachments anywhere on the site named {filename}.
        slots:
          filename: query.filename
      - text: List every site attachment with media type {mediaType}.
        slots:
          mediaType: query.mediaType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/blogposts/{id}/attachments'].get
  update:
    x-apievangelist-phrasing:
      intent: List attachments on a blog post
      effect: read
      questions:
      - What files are attached to a particular blog post?
      - Can I filter a blog post's attachments by file type?
      instructions:
      - text: List the attachments on blog post {id}.
        slots:
          id: path.id
      - text: Find files named {filename} attached to blog post {id}.
        slots:
          filename: query.filename
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom-content/{id}/attachments'].get
  update:
    x-apievangelist-phrasing:
      intent: List attachments on custom content
      effect: read
      questions:
      - Which attachments belong to a custom content item?
      - Can I narrow custom content attachments by media type?
      instructions:
      - text: List the attachments on custom content {id}.
        slots:
          id: path.id
      - text: Show {mediaType} attachments on custom content item {id}.
        slots:
          mediaType: query.mediaType
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/labels/{id}/attachments'].get
  update:
    x-apievangelist-phrasing:
      intent: List attachments carrying a label
      effect: read
      questions:
      - Which attachments have been tagged with a given label?
      - Can I sort the attachments that share a label?
      instructions:
      - text: List attachments tagged with label {id}.
        slots:
          id: path.id
      - text: Show all files that carry label id {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attachments/{id}/thumbnail/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download an attachment's thumbnail image
      effect: read
      questions:
      - How do I get a preview thumbnail for an attachment?
      - Can I request an attachment thumbnail at a specific width and height?
      instructions:
      - text: Download the thumbnail for attachment {id}.
        slots:
          id: path.id
      - text: Get a {width} by {height} thumbnail of attachment {id}.
        slots:
          width: query.width
          height: query.height
          id: path.id
      method: generated
      generated: '2026-10-01'