Postmark · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Postmark Triggers API

4 actions 4 updates phrasing extends openapi/postmark-triggers-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 4

$.info
$.paths['/triggers/inboundrules'].get
$.paths['/triggers/tags'].get
$.paths['/triggers/tags/{triggerid}'].delete

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 Postmark Triggers API
  version: 1.0.0
extends: openapi/postmark-triggers-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['/triggers/inboundrules'].get
  update:
    x-apievangelist-phrasing:
      intent: List inbound blocking rules
      effect: read
      questions:
      - Which senders or domains am I currently blocking from my inbound stream?
      - Can I see all the inbound rule triggers on this server?
      instructions:
      - text: List the first {count} inbound rules.
        slots:
          count: query.count
      - text: Show my inbound blocking rules, skipping {offset}.
        slots:
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/triggers/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: Search tag triggers
      effect: read
      questions:
      - Which tag triggers are set up on my server?
      - Can I find the trigger configured for one delivery tag by name?
      instructions:
      - text: Search tag triggers matching tag name {match_name}.
        slots:
          match_name: query.match_name
      - text: List the first {count} tag triggers, skipping {offset}.
        slots:
          count: query.count
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/triggers/tags/{triggerid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a tag trigger
      effect: destructive
      questions:
      - How do I remove a tag trigger I no longer need?
      - Can I delete one trigger by its ID?
      instructions:
      - text: Delete tag trigger {triggerid}.
        slots:
          triggerid: path.triggerid
      - text: Remove the trigger with ID {triggerid} from my server.
        slots:
          triggerid: path.triggerid
      method: generated
      generated: '2026-10-01'