Postmark · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Postmark Account Server Management API

6 actions 6 updates phrasing extends openapi/postmark-server-management-api-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 6

$.info
$.paths['/servers/{serverid}'].get
$.paths['/servers/{serverid}'].put
$.paths['/servers/{serverid}'].delete
$.paths['/servers'].get
$.paths['/servers'].post

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 Account Server Management API
  version: 1.0.0
extends: openapi/postmark-server-management-api-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: 5
- target: $.paths['/servers/{serverid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a server on the account
      effect: read
      questions:
      - What are the settings of one of the servers on my account?
      - Can I look up any server by ID using my account token?
      instructions:
      - text: Get server {serverid}.
        slots:
          serverid: path.serverid
      - text: Show the webhooks and tracking settings of server {serverid}.
        slots:
          serverid: path.serverid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servers/{serverid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a server by ID
      effect: write
      questions:
      - How do I rename another server on my account?
      - Can I change the webhook URLs of a specific server by its ID?
      instructions:
      - text: Rename server {serverid} to {name}.
        slots:
          serverid: path.serverid
          name: requestBody.Name
      - text: Set the delivery webhook of server {serverid} to {delivery_hook_url}.
        slots:
          serverid: path.serverid
          delivery_hook_url: requestBody.DeliveryHookUrl
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servers/{serverid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a server
      effect: destructive
      questions:
      - How do I permanently remove a server I no longer need?
      - Can I delete a server from my account?
      instructions:
      - text: Delete server {serverid}.
        slots:
          serverid: path.serverid
      - text: Permanently remove server {serverid} from the account.
        slots:
          serverid: path.serverid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servers'].get
  update:
    x-apievangelist-phrasing:
      intent: List servers on the account
      effect: read
      questions:
      - Which servers exist on my account?
      - Can I find a server by its name?
      instructions:
      - text: List the first {count} servers on my account.
        slots:
          count: query.count
      - text: Find servers named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a server
      effect: write
      questions:
      - How do I set up a new server to separate staging mail from production?
      - Can I configure webhooks and tracking while creating a server?
      instructions:
      - text: Create a new server called {name}.
        slots:
          name: requestBody.Name
      - text: Create server {name} colored {color} with open tracking set to {track_opens}.
        slots:
          name: requestBody.Name
          color: requestBody.Color
          track_opens: requestBody.TrackOpens
      method: generated
      generated: '2026-10-01'