Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian The Jira Cloud platform REST Issue Attachments API

9 actions 9 updates phrasing extends openapi/atlassian-issue-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 9

$.info
$.paths['/rest/api/3/attachment/content/{id}'].get
$.paths['/rest/api/3/attachment/meta'].get
$.paths['/rest/api/3/attachment/thumbnail/{id}'].get
$.paths['/rest/api/3/attachment/{id}'].get
$.paths['/rest/api/3/attachment/{id}'].delete
$.paths['/rest/api/3/attachment/{id}/expand/human'].get
$.paths['/rest/api/3/attachment/{id}/expand/raw'].get
$.paths['/rest/api/3/issue/{issueIdOrKey}/attachments'].post

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 Jira Cloud platform REST Issue Attachments API
  version: 1.0.0
extends: openapi/atlassian-issue-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: 8
- target: $.paths['/rest/api/3/attachment/content/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download an attachment's contents
      effect: read
      questions:
      - How do I download the actual file attached to a Jira issue?
      - Can I fetch just a byte range of a large attachment?
      instructions:
      - text: Download the contents of attachment {id}.
        slots:
          id: path.id
      - text: 'Get the file for attachment {id} without following a redirect: {redirect}.'
        slots:
          id: path.id
          redirect: query.redirect
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/attachment/meta'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Jira attachment settings
      effect: read
      questions:
      - Are attachments enabled in my Jira site?
      - What's the maximum file size I can attach to an issue?
      instructions:
      - text: Check whether attachments are enabled and the size limit.
      - text: Show the Jira attachment upload limit.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/attachment/thumbnail/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an attachment's thumbnail image
      effect: read
      questions:
      - Can I get a small preview image of an issue attachment?
      - What if an attachment has no thumbnail, can I get a default image instead?
      instructions:
      - text: Get the thumbnail for attachment {id}.
        slots:
          id: path.id
      - text: Fetch attachment {id}'s thumbnail at {width} by {height} pixels.
        slots:
          id: path.id
          width: query.width
          height: query.height
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/attachment/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an attachment's metadata
      effect: read
      questions:
      - Who uploaded an attachment and when, and how big is it?
      - Can I see an attachment's filename and MIME type without downloading it?
      instructions:
      - text: Get the metadata for attachment {id}.
        slots:
          id: path.id
      - text: Show the author, size and filename of attachment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/attachment/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an attachment from an issue
      effect: destructive
      questions:
      - How do I remove a file someone attached to a Jira issue?
      - Which permission do I need to delete another user's attachment?
      instructions:
      - text: Delete attachment {id}.
        slots:
          id: path.id
      - text: Remove attachment {id} from its issue.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/attachment/{id}/expand/human'].get
  update:
    x-apievangelist-phrasing:
      intent: List a ZIP attachment's contents, human-readable
      effect: read
      questions:
      - What files are inside a ZIP attached to an issue, with readable sizes?
      - Can I see an archive attachment's file list plus the archive's own metadata?
      instructions:
      - text: Show the files inside archive attachment {id} with human-readable details.
        slots:
          id: path.id
      - text: List the contents and metadata of ZIP attachment {id} for display.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/attachment/{id}/expand/raw'].get
  update:
    x-apievangelist-phrasing:
      intent: List a ZIP attachment's contents as raw data
      effect: read
      questions:
      - Is there a raw, machine-oriented listing of files inside a ZIP attachment?
      - Can I get archive entry data for an attachment to process in code?
      instructions:
      - text: Get the raw file entries of archive attachment {id}.
        slots:
          id: path.id
      - text: Return the machine-readable ZIP contents of attachment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/attachments'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach files to a Jira issue
      effect: write
      questions:
      - How do I upload a file to a Jira issue?
      - Why is my attachment upload blocked without the no-check token header?
      instructions:
      - text: Attach a file to issue {issueIdOrKey}.
        slots:
          issueIdOrKey: path.issueIdOrKey
      - text: Upload these screenshots to Jira issue {issueIdOrKey}.
        slots:
          issueIdOrKey: path.issueIdOrKey
      method: generated
      generated: '2026-10-01'