Impact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for impact.com Reward Balance API

3 actions 3 updates phrasing extends openapi/impact-reward-balance-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/{tenant_alias}/reward/balance'].get

$.paths['/{tenant_alias}/credit/bulkredeem'].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 impact.com Reward Balance API
  version: 1.0.0
extends: openapi/impact-reward-balance-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: 2
- target: $.paths['/{tenant_alias}/reward/balance'].get
  update:
    x-apievangelist-phrasing:
      intent: List reward balances for an account
      effect: read
      questions:
      - How much referral credit has an account earned so far?
      - Can I narrow reward balances to one user or reward type?
      instructions:
      - text: List reward balances for account {acct} in tenant {tenant}.
        slots:
          tenant: path.tenant_alias
          acct: query.accountId
      - text: Show {type} balances for user {user} on account {acct}, tenant {tenant}.
        slots:
          tenant: path.tenant_alias
          acct: query.accountId
          user: query.userId
          type: query.rewardTypeFilter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{tenant_alias}/credit/bulkredeem'].post
  update:
    x-apievangelist-phrasing:
      intent: Redeem credit from a reward balance
      effect: destructive
      questions:
      - Can I redeem referral credit an account has earned?
      - Is debiting a reward balance permanent?
      instructions:
      - text: Debit {amount} {unit} from account {acct}'s reward balance in tenant {tenant}.
        slots:
          tenant: path.tenant_alias
          acct: requestBody.accountId
          amount: requestBody.amount
          unit: requestBody.unit
      - text: Redeem {amount} {unit} of credit for account {acct} in tenant {tenant}.
        slots:
          tenant: path.tenant_alias
          acct: requestBody.accountId
          amount: requestBody.amount
          unit: requestBody.unit
      method: generated
      generated: '2026-09-26'