Antavo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Antavo Promotion Engine Cart API

3 actions 3 updates phrasing extends openapi/antavo-cart-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['/v1/cart/finalize'].post
$.paths['/v1/cart'].post

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 Promotion Engine Cart API
  version: 1.0.0
extends: openapi/antavo-cart-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['/v1/cart/finalize'].post
  update:
    x-apievangelist-phrasing:
      intent: Finalize a checkout with promotions
      effect: write
      questions:
      - How do I complete a checkout with the final promotions applied?
      - Can I finalize a cart with a promo code?
      instructions:
      - text: Finalize checkout for cart {cartId} at store {storeId} with promo code {promoCode}.
        slots:
          cartId: requestBody.cartId
          storeId: requestBody.storeId
          promoCode: requestBody.promoCode
      - text: Complete cart {cartId}'s checkout for customer {customerId} and lock in the final promotions.
        slots:
          cartId: requestBody.cartId
          customerId: requestBody.customerId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cart'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview promotions for a cart
      effect: read
      questions:
      - Which promotions would apply to this cart before checkout?
      - Can I simulate discounts for a cart without completing the purchase?
      instructions:
      - text: Preview applicable promotions for cart {cartId} at store {storeId}.
        slots:
          cartId: requestBody.cartId
          storeId: requestBody.storeId
      - text: Simulate discounts on cart items {cart} in {currency} for customer {customerId}.
        slots:
          cart: requestBody.cart
          currency: requestBody.currency
          customerId: requestBody.customerId
      method: generated
      generated: '2026-10-01'