Talon.One · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Management Giveaways API

3 actions 3 updates phrasing extends openapi/talon-one-giveaways-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Talon.One's API. It is a proposal applied on top of the contract, not a document Talon.One publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/v1/giveaways/pools/{poolId}/import'].post
$.paths['/v1/giveaways/pools/{poolId}/export'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Management Giveaways API
  version: 1.0.0
extends: openapi/talon-one-giveaways-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['/v1/giveaways/pools/{poolId}/import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import giveaway codes into a pool
      effect: write
      questions:
      - How do I load a batch of gift card codes into a giveaway pool?
      - What columns does the giveaway code CSV need?
      instructions:
      - text: Import giveaway codes from {upFile} into pool {poolId}.
        slots:
          upFile: requestBody.upFile
          poolId: path.poolId
      - text: Upload the gift card code CSV {upFile} to giveaway pool {poolId}.
        slots:
          upFile: requestBody.upFile
          poolId: path.poolId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/giveaways/pools/{poolId}/export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export a giveaway pool's codes to CSV
      effect: read
      questions:
      - Can I download all the giveaway codes in a pool, including which were awarded?
      - Which giveaway codes were added to a pool within a date window?
      instructions:
      - text: Export the giveaway codes of pool {poolId}.
        slots:
          poolId: path.poolId
      - text: Download codes from giveaway pool {poolId} created after {createdAfter}.
        slots:
          poolId: path.poolId
          createdAfter: query.createdAfter
      method: generated
      generated: '2026-09-26'