Antavo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Antavo Async Events API

3 actions 3 updates phrasing extends openapi/antavo-async-events-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/async/events/{correlation_id}'].get

$.paths['/v1/async/events'].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 Async Events API
  version: 1.0.0
extends: openapi/antavo-async-events-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/async/events/{correlation_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an async event's processing status
      effect: read
      questions:
      - Has my asynchronously submitted event been processed yet?
      - Can I check the outcome of a background event using its correlation ID?
      instructions:
      - text: Check the processing status of async event {correlation_id}.
        slots:
          correlation_id: path.correlation_id
      - text: Show the result of background event {correlation_id}.
        slots:
          correlation_id: path.correlation_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/async/events'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit an event for background processing
      effect: write
      questions:
      - Can I send a loyalty event without waiting for it to be processed?
      - Which event types can be submitted asynchronously?
      instructions:
      - text: Submit this customer event asynchronously.
      - text: Queue a loyalty event for background processing.
      method: generated
      generated: '2026-10-01'