Mailosaur · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mailosaur Files API

4 actions 4 updates phrasing extends openapi/mailosaur-files-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Mailosaur's API. It is a proposal applied on top of the contract, not a document Mailosaur publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/api/files/attachments/{attachmentId}'].get
$.paths['/api/files/email/{messageId}'].get
$.paths['/api/files/screenshots/{previewId}'].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 Mailosaur Files API
  version: 1.0.0
extends: openapi/mailosaur-files-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: 3
- target: $.paths['/api/files/attachments/{attachmentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download an email attachment
      effect: read
      questions:
      - How do I download a file attached to a test email?
      - Can I fetch an attachment's contents to check the invoice PDF my app sent?
      instructions:
      - text: Download attachment {attachmentId}.
        slots:
          attachmentId: path.attachmentId
      - text: Save the attached file {attachmentId} so I can inspect it.
        slots:
          attachmentId: path.attachmentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/files/email/{messageId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download an email as an EML file
      effect: read
      questions:
      - Can I export a captured email as a raw .eml file?
      - How do I get the full original source of a test email?
      instructions:
      - text: Download message {messageId} as an EML file.
        slots:
          messageId: path.messageId
      - text: Export the raw email source of {messageId}.
        slots:
          messageId: path.messageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/files/screenshots/{previewId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download an email client preview screenshot
      effect: read
      questions:
      - How do I download the screenshot of my email rendered in a real email client?
      - Why does the preview screenshot download return 202 instead of an image?
      instructions:
      - text: Download preview screenshot {previewId}.
        slots:
          previewId: path.previewId
      - text: Get the rendered image for email preview {previewId} once it is ready.
        slots:
          previewId: path.previewId
      method: generated
      generated: '2026-10-01'