beehiiv · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Reference Condition Sets API

3 actions 3 updates phrasing extends openapi/beehiiv-condition-sets-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}/condition_sets'].get
$.paths['/publications/{publicationId}/condition_sets/{conditionSetId}'].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 Condition Sets API
  version: 1.0.0
extends: openapi/beehiiv-condition-sets-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}/condition_sets'].get
  update:
    x-apievangelist-phrasing:
      intent: List audience condition sets
      effect: read
      questions:
      - What reusable audience conditions are defined for my dynamic content?
      - Can I filter condition sets by their purpose?
      instructions:
      - text: List active condition sets for publication {publication}.
        slots:
          publication: path.publicationId
      - text: Show condition sets on {publication} with purpose {purpose}.
        slots:
          publication: path.publicationId
          purpose: query.purpose
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publications/{publicationId}/condition_sets/{conditionSetId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one condition set
      effect: read
      questions:
      - How many active subscribers match a particular condition set?
      - Can I view the rules of one dynamic content condition set?
      instructions:
      - text: Get condition set {condition_set} on publication {publication}.
        slots:
          condition_set: path.conditionSetId
          publication: path.publicationId
      - text: Show condition set {condition_set} with its subscriber count stats.
        slots:
          condition_set: path.conditionSetId
      method: generated
      generated: '2026-09-26'