AWeber · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for AWeber Segments API

3 actions 3 updates phrasing extends openapi/aweber-segments-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 3

$.info

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

$.paths['/accounts/{accountId}/lists/{listId}/segments/{segmentId}'].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 Segments API
  version: 1.0.0
extends: openapi/aweber-segments-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: 2
- target: $.paths['/accounts/{accountId}/lists/{listId}/segments'].get
  update:
    x-apievangelist-phrasing:
      intent: List a list's segments
      effect: read
      questions:
      - What saved segments exist on my subscriber list?
      - Can I page through all segments for a list?
      instructions:
      - text: List the segments on list {listId} in account {accountId}.
        slots:
          listId: path.listId
          accountId: path.accountId
      - text: Show {size} segments for list {listId}, account {accountId}, starting at {start}.
        slots:
          size: query.ws.size
          listId: path.listId
          accountId: path.accountId
          start: query.ws.start
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{accountId}/lists/{listId}/segments/{segmentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one segment
      effect: read
      questions:
      - What details are stored for a single segment?
      - Can I look up one segment by its ID to use it in a broadcast?
      instructions:
      - text: Show segment {segmentId} on list {listId} in account {accountId}.
        slots:
          segmentId: path.segmentId
          listId: path.listId
          accountId: path.accountId
      - text: Fetch the details of segment {segmentId} from list {listId}, account {accountId}.
        slots:
          segmentId: path.segmentId
          listId: path.listId
          accountId: path.accountId
      method: generated
      generated: '2026-10-02'