SendPulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SendPulse Web Push Websites API

5 actions 5 updates phrasing extends openapi/sendpulse-websites-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for SendPulse's API. It is a proposal applied on top of the contract, not a document SendPulse publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/push/websites/total'].get

$.paths['/push/websites'].get

$.paths['/push/websites/{id}/variables'].get

$.paths['/push/websites/info/{id}'].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 SendPulse Web Push Websites API
  version: 1.0.0
extends: openapi/sendpulse-websites-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/push/websites/total'].get
  update:
    x-apievangelist-phrasing:
      intent: Count my web push websites
      effect: read
      questions:
      - How many websites do I have set up for web push notifications?
      - What's the total count of my push-enabled sites?
      instructions:
      - text: Count the websites on my web push account.
      - text: Give me the total number of push notification websites.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/push/websites'].get
  update:
    x-apievangelist-phrasing:
      intent: List my web push websites
      effect: read
      questions:
      - Which websites are connected to my web push account?
      - Can I page through my push notification sites?
      instructions:
      - text: List my web push websites.
      - text: Show {limit} push websites starting at offset {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/push/websites/{id}/variables'].get
  update:
    x-apievangelist-phrasing:
      intent: List the variables defined for a push website
      effect: read
      questions:
      - What subscriber variables are defined on one of my web push sites?
      - Can I see the custom variables I can use for a push website?
      instructions:
      - text: List the variables for push website {id}.
        slots:
          id: path.id
      - text: Show which subscriber variables website {id} collects.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/push/websites/info/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of a web push website
      effect: read
      questions:
      - What details are stored for a specific web push website?
      - Can I look up the settings of one push-enabled site?
      instructions:
      - text: Get the details of push website {id}.
        slots:
          id: path.id
      - text: Show me information about web push site {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'