Antavo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Antavo Points Preview Points Preview API

2 actions 2 updates phrasing extends openapi/antavo-points-preview-api-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 2

$.info

$.paths['/extensions/automation/campaign-bonus'].post

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 Points Preview Points Preview API
  version: 1.0.0
extends: openapi/antavo-points-preview-api-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: 1
- target: $.paths['/extensions/automation/campaign-bonus'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview points for a purchase
      effect: read
      questions:
      - How many bonus points would a purchase earn before checkout?
      - Can I preview campaign bonus points for a transaction?
      instructions:
      - text: Preview points for customer {customer} on {action} with data {data}.
        slots:
          customer: requestBody.customer
          action: requestBody.action
          data: requestBody.data
      - text: Estimate the campaign bonus customer {customer} would earn for this {action} event, data {data}.
        slots:
          customer: requestBody.customer
          action: requestBody.action
          data: requestBody.data
      method: generated
      generated: '2026-10-01'