beehiiv · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OAuth2 Authorizations API

2 actions 2 updates phrasing extends openapi/beehiiv-authorizations-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['/oauth/authorize'].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 OAuth2 Authorizations API
  version: 1.0.0
extends: openapi/beehiiv-authorizations-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['/oauth/authorize'].get
  update:
    x-apievangelist-phrasing:
      intent: Start the OAuth authorization flow
      effect: read
      questions:
      - How do I send a beehiiv user to log in and grant my app access?
      - Can I use PKCE with a code challenge when starting authorization?
      - What scopes can I request when redirecting a user to consent?
      instructions:
      - text: Start OAuth authorization for client {client_id} redirecting back to {redirect_uri} with response type {response_type}.
        slots:
          client_id: query.client_id
          redirect_uri: query.redirect_uri
          response_type: query.response_type
      - text: Build the consent URL for client {client_id} asking for scopes {scope} and returning to {redirect_uri} as {response_type}.
        slots:
          client_id: query.client_id
          scope: query.scope
          redirect_uri: query.redirect_uri
          response_type: query.response_type
      method: generated
      generated: '2026-09-26'