beehiiv · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Reference Authors API

3 actions 3 updates phrasing extends openapi/beehiiv-authors-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/{publicationId}/authors'].get
$.paths['/publications/{publicationId}/authors/{authorId}'].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 Authors API
  version: 1.0.0
extends: openapi/beehiiv-authors-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/{publicationId}/authors'].get
  update:
    x-apievangelist-phrasing:
      intent: List a publication's authors
      effect: read
      questions:
      - Who are the authors that can write for my newsletter?
      - Can I search a publication's authors by name?
      instructions:
      - text: List the authors on publication {publication}.
        slots:
          publication: path.publicationId
      - text: Find authors named {name} on {publication}.
        slots:
          name: query.name
          publication: path.publicationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publications/{publicationId}/authors/{authorId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one author's details
      effect: read
      questions:
      - What profile details are stored for a specific author?
      - Can I look up a single writer on my publication by their ID?
      instructions:
      - text: Get author {author} from publication {publication}.
        slots:
          author: path.authorId
          publication: path.publicationId
      - text: Show me the profile of author {author}.
        slots:
          author: path.authorId
      method: generated
      generated: '2026-09-26'