# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Zendesk Attachments API
  version: 1.0.0
extends: openapi/zendesk-attachments-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/api/v2/attachments/{attachment_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get attachment details
      effect: read
      questions:
      - How do I get the details of a file attached to a ticket comment?
      - Where do I find an attachment's id before looking it up?
      instructions:
      - text: Show the details of the attachment on that ticket comment.
      - text: Get the file name, size and URL for this attachment.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/attachments/{attachment_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Allow or restrict access to a malware attachment
      effect: write
      questions:
      - Can I let agents open an attachment that was flagged as malware?
      - How do I restrict agent access to a file with detected malware?
      instructions:
      - text: Restrict agent access to that malware-flagged attachment.
      - text: Allow agents to open this attachment even though malware was detected.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/tickets/{ticket_id}/comments/{comment_id}/attachments/{attachment_id}/redact'].put
  update:
    x-apievangelist-phrasing:
      intent: Permanently redact an attachment from a comment
      effect: destructive
      questions:
      - How do I permanently remove a sensitive file from a ticket comment?
      - Can attachment redaction be undone?
      instructions:
      - text: Redact the attachment containing the customer's ID scan from that ticket comment.
      - text: Permanently remove this file from the comment, replacing it with redacted.txt.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/uploads'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a file for a ticket comment
      effect: write
      questions:
      - How do I upload a file so I can attach it to a ticket comment?
      - Does uploading a file attach it to the comment automatically?
      instructions:
      - text: Upload this screenshot so I can attach it to a ticket reply.
      - text: Upload the PDF and give me the token for my next comment.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/uploads/{token}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an uploaded file by token
      effect: destructive
      questions:
      - Can I delete a file I uploaded before it gets attached to a comment?
      - How do I remove an upload using its token?
      instructions:
      - text: Delete the upload with token {token}.
        slots:
          token: path.token
      - text: Remove uploaded file {token} since I attached the wrong one.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-26'