Stax · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for stax-api Surcharge API

2 actions 2 updates phrasing extends openapi/stax-surcharge-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Stax's API. It is a proposal applied on top of the contract, not a document Stax publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info
$.paths['/surcharge/review'].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 stax-api Surcharge API
  version: 1.0.0
extends: openapi/stax-surcharge-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['/surcharge/review'].get
  update:
    x-apievangelist-phrasing:
      intent: Preview the surcharge for a payment method
      effect: read
      questions:
      - What surcharge would a customer pay if I charged their saved card?
      - Can I preview the surcharge amount on a total before running the charge?
      instructions:
      - text: Review the surcharge for payment method {payment_method_id}.
        slots:
          payment_method_id: query.payment_method_id
      - text: Show the surcharge on a {total} charge to payment method {payment_method_id}.
        slots:
          total: query.total
          payment_method_id: query.payment_method_id
      method: generated
      generated: '2026-09-26'