beehiiv · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Reference Complimentary Access API

3 actions 3 updates phrasing extends openapi/beehiiv-complimentary-access-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}/complimentary_access'].get
$.paths['/publications/{publicationId}/complimentary_access/{complimentaryAccessId}'].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 Complimentary Access API
  version: 1.0.0
extends: openapi/beehiiv-complimentary-access-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}/complimentary_access'].get
  update:
    x-apievangelist-phrasing:
      intent: List complimentary access grants
      effect: read
      questions:
      - Who has been given free complimentary access to my paid newsletter?
      - Can I page through all comp access grants with a cursor?
      instructions:
      - text: List complimentary access grants for publication {publication}.
        slots:
          publication: path.publicationId
      - text: Show the next page of complimentary access for {publication} after cursor {cursor}.
        slots:
          publication: path.publicationId
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publications/{publicationId}/complimentary_access/{complimentaryAccessId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one complimentary access grant
      effect: read
      questions:
      - What are the details of a specific complimentary access grant?
      - Can I look up a single comp subscription by its ID?
      instructions:
      - text: Get complimentary access {access} on publication {publication}.
        slots:
          access: path.complimentaryAccessId
          publication: path.publicationId
      - text: Show the comp access grant {access}.
        slots:
          access: path.complimentaryAccessId
      method: generated
      generated: '2026-09-26'