SendPulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SendPulse Pop-up Project API

3 actions 3 updates phrasing extends openapi/sendpulse-project-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 3

$.info
$.paths['/public/api/widgets/list'].get
$.paths['/public/api/widgets'].post

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 SendPulse Pop-up Project API
  version: 1.0.0
extends: openapi/sendpulse-project-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: 2
- target: $.paths['/public/api/widgets/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List projects
      effect: read
      questions:
      - What projects do I have set up?
      - Can I page through my projects list?
      instructions:
      - text: List my projects.
      - text: Show {first} projects starting at offset {offset}.
        slots:
          first: query.first
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/api/widgets'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a project
      effect: write
      questions:
      - How do I create a new project for my website?
      - Can I set a site URL when creating a project?
      instructions:
      - text: Create a project named {name} for {url}.
        slots:
          name: requestBody.name
          url: requestBody.url
      - text: Add a new project called {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-10-01'