Antavo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Antavo Display History API

3 actions 3 updates phrasing extends openapi/antavo-history-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Antavo's API. It is a proposal applied on top of the contract, not a document Antavo publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/customers/{customer_id}/events'].get
$.paths['/customers/-/events'].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 Antavo Display History API
  version: 1.0.0
extends: openapi/antavo-history-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['/customers/{customer_id}/events'].get
  update:
    x-apievangelist-phrasing:
      intent: List one customer's event history
      effect: read
      questions:
      - What has a specific member done in the loyalty program?
      - Can I list only the events that changed a customer's points?
      instructions:
      - text: List events for customer {customer_id}.
        slots:
          customer_id: path.customer_id
      - text: Show customer {customer_id}'s {action} events on {date}.
        slots:
          customer_id: path.customer_id
          action: query.action
          date: query.date
      - text: List customer {customer_id}'s events with points_only set to {points_only}.
        slots:
          customer_id: path.customer_id
          points_only: query.points_only
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customers/-/events'].get
  update:
    x-apievangelist-phrasing:
      intent: List events for all customers by time
      effect: read
      questions:
      - Can I pull every event across all customers in a time window?
      - Which events were recorded after a given timestamp?
      instructions:
      - text: List all customer events after {after}.
        slots:
          after: query.timestamp.gt
      - text: Get every event between {start} and {end} across all members.
        slots:
          start: query.timestamp.gte
          end: query.timestamp.lte
      method: generated
      generated: '2026-10-01'