Antavo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Antavo Display Prize wheels API

4 actions 4 updates phrasing extends openapi/antavo-prize-wheels-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}/prize-wheels/{pw_id}'].get

$.paths['/customers/{customer_id}/prize-wheels/{pw_id}'].post

$.paths['/customers/{customer_id}/prize-wheels'].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 Prize wheels API
  version: 1.0.0
extends: openapi/antavo-prize-wheels-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}/prize-wheels/{pw_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a prize wheel's slices
      effect: read
      questions:
      - What prizes are on each slice of a prize wheel?
      - Can I include full reward details in the wheel slice data?
      instructions:
      - text: Show the slices of prize wheel {pw_id} for customer {customer_id}.
        slots:
          pw_id: path.pw_id
          customer_id: path.customer_id
      - text: Get wheel {pw_id}'s slices with fields {fields} for customer {customer_id}.
        slots:
          pw_id: path.pw_id
          fields: query.fields
          customer_id: path.customer_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customers/{customer_id}/prize-wheels/{pw_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Spin a prize wheel for a customer
      effect: write
      questions:
      - Can a member spin a prize wheel through the API?
      - What enters a customer into a prize wheel draw?
      instructions:
      - text: Spin prize wheel {pw_id} for customer {customer_id}.
        slots:
          pw_id: path.pw_id
          customer_id: path.customer_id
      - text: Enter customer {customer_id} in the prize wheel {pw_id} draw.
        slots:
          customer_id: path.customer_id
          pw_id: path.pw_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customers/{customer_id}/prize-wheels'].get
  update:
    x-apievangelist-phrasing:
      intent: List prize wheels for a customer
      effect: read
      questions:
      - Which prize wheels can a customer play?
      - Can I page through the prize wheels available to a member?
      instructions:
      - text: List prize wheels available to customer {customer_id}.
        slots:
          customer_id: path.customer_id
      - text: Show {limit} prize wheels for customer {customer_id} from offset {offset}.
        slots:
          limit: query.limit
          customer_id: path.customer_id
          offset: query.offset
      method: generated
      generated: '2026-10-01'