Postmark · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Postmark Bounceid API

3 actions 3 updates phrasing extends openapi/postmark-bounceid-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Postmark's API. It is a proposal applied on top of the contract, not a document Postmark publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/bounces/{bounceid}'].get

$.paths['/bounces/{bounceid}/dump'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Postmark Bounceid API
  version: 1.0.0
extends: openapi/postmark-bounceid-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['/bounces/{bounceid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one bounce
      effect: read
      questions:
      - What exactly caused a particular bounce I'm looking at?
      - Can I see the full details of a single bounce by its ID?
      instructions:
      - text: Get the details of bounce {bounceid}.
        slots:
          bounceid: path.bounceid
      - text: Tell me why bounce {bounceid} happened and whether it can be reactivated.
        slots:
          bounceid: path.bounceid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/bounces/{bounceid}/dump'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the raw dump of a bounce
      effect: read
      questions:
      - Can I see the raw SMTP source of a bounced message?
      - Where do I get the full bounce dump to debug why a message failed?
      instructions:
      - text: Get the raw dump for bounce {bounceid}.
        slots:
          bounceid: path.bounceid
      - text: Show the original bounce message source for bounce {bounceid}.
        slots:
          bounceid: path.bounceid
      method: generated
      generated: '2026-10-01'