Thanx · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thanx Consumer Gift Cards API

3 actions 3 updates phrasing extends openapi/thanx-gift-cards-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/gift_cards'].get

$.paths['/gift_cards'].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 Thanx Consumer Gift Cards API
  version: 1.0.0
extends: openapi/thanx-gift-cards-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['/gift_cards'].get
  update:
    x-apievangelist-phrasing:
      intent: List my gift cards
      effect: read
      questions:
      - Which gift cards do I have on my account?
      - Can I check the digital gift cards I already own?
      instructions:
      - text: List my gift cards.
      - text: Show all the gift cards on my account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gift_cards'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a digital gift card
      effect: write
      questions:
      - How do I create a new digital gift card?
      - Can I buy an e-gift card through the loyalty program?
      instructions:
      - text: Create a new digital gift card.
      - text: Create a gift card with details {gift_card}.
        slots:
          gift_card: requestBody.gift_card
      method: generated
      generated: '2026-09-26'