Impact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SaaSquatch by impact.com Referral API

5 actions 5 updates phrasing extends openapi/impact-referral-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 5

$.info

$.paths['/{tenant_alias}/referrals'].get

$.paths['/{tenant_alias}/referrals/{referralId}'].get

$.paths['/{tenant_alias}/referrals/moderate'].post

$.paths['/{tenant_alias}/open/referrals'].get

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 SaaSquatch by impact.com Referral API
  version: 1.0.0
extends: openapi/impact-referral-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: 4
- target: $.paths['/{tenant_alias}/referrals'].get
  update:
    x-apievangelist-phrasing:
      intent: List referrals in a tenant
      effect: read
      questions:
      - Which referrals have been made in my referral program?
      - Can I filter referrals by moderation status or when they were paid?
      instructions:
      - text: List referrals in tenant {tenant} made by user {user}.
        slots:
          tenant: path.tenant_alias
          user: query.referringUserId
      - text: Show referrals in tenant {tenant} with referred moderation status {status}.
        slots:
          tenant: path.tenant_alias
          status: query.referredModerationStatus
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{tenant_alias}/referrals/{referralId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a referral
      effect: read
      questions:
      - What are the details of one specific referral?
      - Can I fetch a single referral by its ID?
      instructions:
      - text: Get referral {referral} in tenant {tenant}.
        slots:
          tenant: path.tenant_alias
          referral: path.referralId
      - text: Show referral {referral} details in tenant {tenant}.
        slots:
          tenant: path.tenant_alias
          referral: path.referralId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{tenant_alias}/referrals/moderate'].post
  update:
    x-apievangelist-phrasing:
      intent: Approve or deny referrals
      effect: write
      questions:
      - How do I approve or deny several pending referrals at once?
      - Can I reject a referral that looks fraudulent?
      instructions:
      - text: Apply moderation actions {actions} to referrals in tenant {tenant}.
        slots:
          tenant: path.tenant_alias
          actions: requestBody.actions
      - text: Approve or deny referrals in tenant {tenant} using {actions}.
        slots:
          tenant: path.tenant_alias
          actions: requestBody.actions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{tenant_alias}/open/referrals'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's referrals (open endpoint)
      effect: read
      questions:
      - Can a front-end widget show the referrals a given user made or received?
      - Is the open referrals list enabled by default?
      instructions:
      - text: Via the open endpoint in tenant {tenant}, list referrals made by user {user}.
        slots:
          tenant: path.tenant_alias
          user: query.referringUserId
      - text: Open-list referrals received by user {user} in tenant {tenant}.
        slots:
          tenant: path.tenant_alias
          user: query.referredUserId
      method: generated
      generated: '2026-09-26'