Postmark · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Postmark Bypass API

2 actions 2 updates phrasing extends openapi/postmark-bypass-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 2

$.info

$.paths['/messages/inbound/{messageid}/bypass'].put

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 Bypass API
  version: 1.0.0
extends: openapi/postmark-bypass-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: 1
- target: $.paths['/messages/inbound/{messageid}/bypass'].put
  update:
    x-apievangelist-phrasing:
      intent: Let a blocked inbound email through
      effect: write
      questions:
      - An inbound email got blocked by my rules — how do I let it through?
      - Can I bypass inbound rules for just one blocked message?
      instructions:
      - text: Bypass inbound rules for blocked message {messageid}.
        slots:
          messageid: path.messageid
      - text: Release blocked inbound email {messageid} past the rules.
        slots:
          messageid: path.messageid
      method: generated
      generated: '2026-10-01'