beehiiv · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Reference Publications API

3 actions 3 updates phrasing extends openapi/beehiiv-publications-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for beehiiv's API. It is a proposal applied on top of the contract, not a document beehiiv publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/publications'].get
$.paths['/publications/{publicationId}'].get

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 Reference Publications API
  version: 1.0.0
extends: openapi/beehiiv-publications-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/publications'].get
  update:
    x-apievangelist-phrasing:
      intent: List my publications
      effect: read
      questions:
      - Which newsletters can my API key access?
      - Can I list all my publications with their stats?
      instructions:
      - text: List all publications on my account.
      - text: Show my publications ordered by {order_by}.
        slots:
          order_by: query.order_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publications/{publicationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one publication
      effect: read
      questions:
      - What are the details and subscriber stats for one of my newsletters?
      - Can I retrieve a single publication by its ID?
      instructions:
      - text: Get publication {publication}.
        slots:
          publication: path.publicationId
      - text: Show publication {publication} with {expand} expanded.
        slots:
          publication: path.publicationId
          expand: query.expand
      method: generated
      generated: '2026-09-26'