beehiiv · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Reference Workspaces API

4 actions 4 updates phrasing extends openapi/beehiiv-workspaces-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 4

$.info

$.paths['/workspaces/identify'].get

$.paths['/workspaces/permissions'].get

$.paths['/workspaces/publications/by_subscription_email/{email}'].get

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 Reference Workspaces API
  version: 1.0.0
extends: openapi/beehiiv-workspaces-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: 3
- target: $.paths['/workspaces/identify'].get
  update:
    x-apievangelist-phrasing:
      intent: Identify the workspace behind a token
      effect: read
      questions:
      - Which workspace is my API key or OAuth token tied to?
      - Can I confirm what organization my credentials belong to?
      instructions:
      - text: Tell me which workspace this token belongs to.
      - text: Show the workspace details for my current API key.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List the scopes granted to a token
      effect: read
      questions:
      - What permissions does my current token have in this workspace?
      - Why doesn't my token include write access to posts?
      instructions:
      - text: List the permissions my token has in this workspace.
      - text: Show which OAuth scopes are granted to my credentials.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/publications/by_subscription_email/{email}'].get
  update:
    x-apievangelist-phrasing:
      intent: Find publications an email subscribes to
      effect: read
      questions:
      - Which of my newsletters is a given email subscribed to?
      - Can I search the whole workspace for publications a reader follows?
      instructions:
      - text: Find every publication in my workspace where {email} is subscribed.
        slots:
          email: path.email
      - text: List my newsletters that {email} subscribes to, with {expand} expanded.
        slots:
          email: path.email
          expand: query.expand
      method: generated
      generated: '2026-09-26'