AWeber · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for AWeber Lists API

5 actions 5 updates phrasing extends openapi/aweber-lists-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/accounts/{accountId}/lists'].get

$.paths['/accounts/{accountId}/lists/{listId}'].get

$.paths['/accounts/{accountId}/lists?ws.op=find'].get

$.paths['/accounts/{accountId}/lists/{listId}/tags'].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 AWeber Lists API
  version: 1.0.0
extends: openapi/aweber-lists-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/accounts/{accountId}/lists'].get
  update:
    x-apievangelist-phrasing:
      intent: List all subscriber lists in an account
      effect: read
      questions:
      - What subscriber lists do I have in my account?
      - Can I page through every list on an account a few at a time?
      instructions:
      - text: List all subscriber lists in account {accountId}.
        slots:
          accountId: path.accountId
      - text: Show {size} lists from account {accountId} starting at {start}.
        slots:
          size: query.ws.size
          accountId: path.accountId
          start: query.ws.start
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{accountId}/lists/{listId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one subscriber list
      effect: read
      questions:
      - What settings and subscriber totals does one list have?
      - Can I pull up a single list when I already know its list ID?
      instructions:
      - text: Show list {listId} in account {accountId}.
        slots:
          listId: path.listId
          accountId: path.accountId
      - text: Get the details of subscriber list {listId}, account {accountId}.
        slots:
          listId: path.listId
          accountId: path.accountId
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{accountId}/lists?ws.op=find'].get
  update:
    x-apievangelist-phrasing:
      intent: Find a list by name
      effect: read
      questions:
      - How do I find a list's ID when I only know its name?
      - Can I search my lists by name instead of browsing all of them?
      instructions:
      - text: Find the list named {name} in account {accountId}.
        slots:
          name: query.name
          accountId: path.accountId
      - text: Search account {accountId} for lists called {name} using {op}.
        slots:
          accountId: path.accountId
          name: query.name
          op: query.ws.op
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{accountId}/lists/{listId}/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the most popular tags on a list
      effect: read
      questions:
      - Which tags are used most often on my list's subscribers?
      - How many tags will come back when I ask for a list's tags?
      instructions:
      - text: Show the most popular tags on list {listId} in account {accountId}.
        slots:
          listId: path.listId
          accountId: path.accountId
      - text: Get the top tags by popularity for list {listId}, account {accountId}.
        slots:
          listId: path.listId
          accountId: path.accountId
      method: generated
      generated: '2026-10-02'