beehiiv · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Reference OAUTH Users API

2 actions 2 updates phrasing extends openapi/beehiiv-oauth-users-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 2

$.info

$.paths['/users/identify'].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 OAUTH Users API
  version: 1.0.0
extends: openapi/beehiiv-oauth-users-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: 1
- target: $.paths['/users/identify'].get
  update:
    x-apievangelist-phrasing:
      intent: Identify the user behind an OAuth token
      effect: read
      questions:
      - Which beehiiv user authorized my app's access token?
      - Can I get the name and email of the person who connected their account?
      instructions:
      - text: Tell me which user authorized this OAuth token.
      - text: Show the profile of the user who connected my app.
      method: generated
      generated: '2026-09-26'