Swetrix · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Swetrix Admin Annotations Revenue API

2 actions 2 updates phrasing extends openapi/swetrix-revenue-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Swetrix's API. It is a proposal applied on top of the contract, not a document Swetrix publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/log/revenue'].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 Swetrix Admin Annotations Revenue API
  version: 1.0.0
extends: openapi/swetrix-revenue-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/log/revenue'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a sale, refund or subscription payment
      effect: write
      questions:
      - How do I send a completed sale from my server into Swetrix revenue analytics?
      - Should refund amounts be sent as negative numbers or is there a transaction type?
      - Can I attach a product name and transaction ID so revenue isn't double counted?
      instructions:
      - text: Record a {type} of {amount} {currency} for project {pid}.
        slots:
          type: requestBody.type
          amount: requestBody.amount
          currency: requestBody.currency
          pid: requestBody.pid
      - text: Log transaction {transactionId} as a {type} of {amount} {currency} for product {productName} in project {pid}.
        slots:
          transactionId: requestBody.transactionId
          type: requestBody.type
          amount: requestBody.amount
          currency: requestBody.currency
          productName: requestBody.productName
          pid: requestBody.pid
      method: generated
      generated: '2026-09-26'