Antavo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Antavo Socal Share Campaigns Social Share Campaigns API

2 actions 2 updates phrasing extends openapi/antavo-social-share-campaigns-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 2

$.info

$.paths['/v1/social-share-campaigns/share-intent'].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 Socal Share Campaigns Social Share Campaigns API
  version: 1.0.0
extends: openapi/antavo-social-share-campaigns-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: 1
- target: $.paths['/v1/social-share-campaigns/share-intent'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a social share intent
      effect: write
      questions:
      - Can I record that a member intends to share a campaign link on social media?
      - Which details trigger a share intent success event?
      instructions:
      - text: Register share intent for customer {customer_id} sharing {url} on {platform}.
        slots:
          customer_id: requestBody.customer_id
          url: requestBody.url
          platform: requestBody.platform
      - text: Log that member {customer_id} is sharing {url} to {platform}.
        slots:
          customer_id: requestBody.customer_id
          url: requestBody.url
          platform: requestBody.platform
      method: generated
      generated: '2026-10-01'