Mailosaur · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mailosaur Usage API

3 actions 3 updates phrasing extends openapi/mailosaur-usage-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 3

$.info
$.paths['/api/usage/limits'].get
$.paths['/api/usage/transactions'].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 Usage API
  version: 1.0.0
extends: openapi/mailosaur-usage-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: 2
- target: $.paths['/api/usage/limits'].get
  update:
    x-apievangelist-phrasing:
      intent: Check account usage limits
      effect: read
      questions:
      - How close is my account to its email and SMS limits?
      - What are my current plan limits and how much have I used?
      instructions:
      - text: Show my account's current usage limits.
      - text: Tell me how much of my plan allowance I've used so far.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/usage/transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: Review recent usage transactions
      effect: read
      questions:
      - What usage did my account rack up over the past month?
      - Can I see a day-by-day history of transactional usage for the last 31 days?
      instructions:
      - text: List my usage transactions for the last 31 days.
      - text: Pull the recent usage history for my account.
      method: generated
      generated: '2026-10-01'