Antavo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Antavo Offers API

4 actions 4 updates phrasing extends openapi/antavo-offers-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/offers'].get

$.paths['/customers/{customer_id}/activities/offers/{offer_id}/claim'].post

$.paths['/offers/'].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 Offers API
  version: 1.0.0
extends: openapi/antavo-offers-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/offers'].get
  update:
    x-apievangelist-phrasing:
      intent: List offers available to a customer
      effect: read
      questions:
      - Which offers are available to a specific member?
      - Can I see every offer a customer could claim?
      instructions:
      - text: List offers available to customer {customer_id}.
        slots:
          customer_id: path.customer_id
      - text: Show customer {customer_id}'s open offers.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customers/{customer_id}/activities/offers/{offer_id}/claim'].post
  update:
    x-apievangelist-phrasing:
      intent: Claim an offer for a customer
      effect: write
      questions:
      - Can I claim an offer on a customer's behalf?
      - What records that a member took up an offer?
      instructions:
      - text: Claim offer {offer_id} for customer {customer_id}.
        slots:
          offer_id: path.offer_id
          customer_id: path.customer_id
      - text: Redeem offer {offer_id} on behalf of member {customer_id}.
        slots:
          offer_id: path.offer_id
          customer_id: path.customer_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/offers/'].post
  update:
    x-apievangelist-phrasing:
      intent: Get offers for a cart's products
      effect: read
      questions:
      - Which product offers apply to what's in a customer's cart?
      - Can I return only the offers a customer is eligible for?
      instructions:
      - text: Get offers for customer {customer} on cart {cart}.
        slots:
          customer: requestBody.customer
          cart: requestBody.cart
      - text: Find offers for cart {cart} at store {store} for customer {customer}, eligible only {eligible_only}.
        slots:
          cart: requestBody.cart
          store: requestBody.store
          customer: requestBody.customer
          eligible_only: requestBody.eligible_only
      method: generated
      generated: '2026-10-01'