Postmark · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Postmark Templates API

3 actions 3 updates phrasing extends openapi/postmark-templates-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['/templates'].get

$.paths['/templates/validate'].post

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 Templates API
  version: 1.0.0
extends: openapi/postmark-templates-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['/templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List the server's templates
      effect: read
      questions:
      - Which email templates exist on this server?
      - Can I page through my templates to find an alias?
      instructions:
      - text: List the first {count} templates.
        slots:
          count: query.count
      - text: Show my templates, skipping {offset}.
        slots:
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/templates/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate and preview template content
      effect: read
      questions:
      - Will my template syntax render correctly before I save it?
      - Can I preview a template's output with sample data?
      instructions:
      - text: Validate this template subject and HTML before I save it.
      - text: Test-render this template text body with sample model data.
      method: generated
      generated: '2026-10-01'