Antavo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Antavo Coupon pools API

3 actions 3 updates phrasing extends openapi/antavo-coupon-pools-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/coupon-pools/{coupon_pool_id}/update'].post
$.paths['/v1/coupon-pools'].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 Coupon pools API
  version: 1.0.0
extends: openapi/antavo-coupon-pools-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/coupon-pools/{coupon_pool_id}/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a coupon pool
      effect: write
      questions:
      - Can I change the value or expiration of an existing coupon pool?
      - What does the update method control when editing a coupon pool?
      instructions:
      - text: Update coupon pool {coupon_pool_id} using method {update_method}.
        slots:
          coupon_pool_id: path.coupon_pool_id
          update_method: requestBody.update_method
      - text: Set the value of coupon pool {coupon_pool_id} to {value} with update method {update_method}.
        slots:
          coupon_pool_id: path.coupon_pool_id
          value: requestBody.value
          update_method: requestBody.update_method
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/coupon-pools'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a coupon pool
      effect: write
      questions:
      - Can I set up a new pool of coupons with a fixed discount value?
      - Which fields are required to create a coupon pool?
      instructions:
      - text: Create a coupon pool named {name} with source {source} and type {type}.
        slots:
          name: requestBody.name
          source: requestBody.source
          type: requestBody.type
      - text: Create coupon pool {name} ({type}, source {source}) worth {value} {currency}.
        slots:
          name: requestBody.name
          type: requestBody.type
          source: requestBody.source
          value: requestBody.value
          currency: requestBody.currency
      method: generated
      generated: '2026-10-01'