Antavo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Antavo Display Activities API

4 actions 4 updates phrasing extends openapi/antavo-activities-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 4

$.info

$.paths['/customers/{customer_id}/activities/earn'].get

$.paths['/customers/{customer_id}/activities/spend'].get

$.paths['/customers/{customer_id}/activities'].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 Antavo Display Activities API
  version: 1.0.0
extends: openapi/antavo-activities-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: 3
- target: $.paths['/customers/{customer_id}/activities/earn'].get
  update:
    x-apievangelist-phrasing:
      intent: List ways a customer can earn
      effect: read
      questions:
      - Which ways can this member earn points right now?
      - Can I list only the earning opportunities for a customer?
      instructions:
      - text: List the earn activities for customer {customer_id}.
        slots:
          customer_id: path.customer_id
      - text: Show every way customer {customer_id} can earn.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customers/{customer_id}/activities/spend'].get
  update:
    x-apievangelist-phrasing:
      intent: List ways a customer can spend
      effect: read
      questions:
      - What can a member spend their points on?
      - Which redemption options are open to this customer?
      instructions:
      - text: List the spend activities for customer {customer_id}.
        slots:
          customer_id: path.customer_id
      - text: Show where customer {customer_id} can redeem points.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customers/{customer_id}/activities'].get
  update:
    x-apievangelist-phrasing:
      intent: List all earn and spend activities
      effect: read
      questions:
      - Can I get both earn and spend activities for a customer in one call?
      - Can I limit the activity feed to specific activity types?
      instructions:
      - text: List all activities, earn and spend together, for customer {customer_id}.
        slots:
          customer_id: path.customer_id
      - text: Show customer {customer_id}'s activities of types {activity_types} with fields {fields}.
        slots:
          customer_id: path.customer_id
          activity_types: query.activity_types
          fields: query.fields
      method: generated
      generated: '2026-10-01'