Antavo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Antavo Display Contests API

3 actions 3 updates phrasing extends openapi/antavo-contests-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['/customers/{customer_id}/activities/contests'].get

$.paths['/customers/{customer_id}/activities/contests/{contest_id}/enter'].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 Display Contests API
  version: 1.0.0
extends: openapi/antavo-contests-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['/customers/{customer_id}/activities/contests'].get
  update:
    x-apievangelist-phrasing:
      intent: List contests open to a customer
      effect: read
      questions:
      - Which contests can a member enter right now?
      - Can I choose which contest fields are returned?
      instructions:
      - text: List contests open to customer {customer_id}.
        slots:
          customer_id: path.customer_id
      - text: Show contests for customer {customer_id} with fields {fields}.
        slots:
          customer_id: path.customer_id
          fields: query.fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customers/{customer_id}/activities/contests/{contest_id}/enter'].post
  update:
    x-apievangelist-phrasing:
      intent: Enter a customer into a contest
      effect: write
      questions:
      - Can a customer submit more than one entry into a contest?
      - What does it take to put a member into a contest draw?
      instructions:
      - text: Enter customer {customer_id} into contest {contest_id}.
        slots:
          customer_id: path.customer_id
          contest_id: path.contest_id
      - text: Submit {count} entries for customer {customer_id} in contest {contest_id}.
        slots:
          count: requestBody.count
          customer_id: path.customer_id
          contest_id: path.contest_id
      method: generated
      generated: '2026-10-01'