Antavo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Antavo Display Quizzes API

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

$.paths['/customers/{customer_id}/activities/quizzes'].get

$.paths['/customers/{customer_id}/activities/quizzes/{quiz_id}/earn'].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 Quizzes API
  version: 1.0.0
extends: openapi/antavo-quizzes-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/quizzes/{quiz_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a quiz's details
      effect: read
      questions:
      - What are the questions and settings of a specific quiz?
      - Can I see one quiz as a given customer would?
      instructions:
      - text: Get quiz {quiz_id} for customer {customer_id}.
        slots:
          quiz_id: path.quiz_id
          customer_id: path.customer_id
      - text: Show the details of quiz {quiz_id} as seen by customer {customer_id}.
        slots:
          quiz_id: path.quiz_id
          customer_id: path.customer_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customers/{customer_id}/activities/quizzes'].get
  update:
    x-apievangelist-phrasing:
      intent: List quizzes for a customer
      effect: read
      questions:
      - Which quizzes can a member answer?
      - Can I page through the quizzes open to a customer?
      instructions:
      - text: List quizzes for customer {customer_id}.
        slots:
          customer_id: path.customer_id
      - text: Show {limit} quizzes available to customer {customer_id} from offset {offset}.
        slots:
          limit: query.limit
          customer_id: path.customer_id
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customers/{customer_id}/activities/quizzes/{quiz_id}/earn'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a quiz answer
      effect: write
      questions:
      - How do I submit a member's quiz answer?
      - Can a customer earn by answering a quiz?
      instructions:
      - text: Submit answer {answer} to quiz {quiz_id} for customer {customer_id}.
        slots:
          answer: requestBody.answer
          quiz_id: path.quiz_id
          customer_id: path.customer_id
      - text: Answer quiz {quiz_id} with {answer} on behalf of customer {customer_id}.
        slots:
          quiz_id: path.quiz_id
          answer: requestBody.answer
          customer_id: path.customer_id
      method: generated
      generated: '2026-10-01'