Tabby · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Tabby API Reference Checkout API

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

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/api/v2/checkout'].post
$.paths['/api/v2/checkout/{id}'].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 Tabby API Reference Checkout API
  version: 1.0.0
extends: openapi/tabby-checkout-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['/api/v2/checkout'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a buy-now-pay-later checkout session
      effect: write
      questions:
      - How do I start a Tabby checkout for a shopper's order?
      - Can I find out whether a customer is pre-approved before sending them to the payment page?
      - What merchant code and language do I need to open a new checkout session?
      - Where do I set the URLs a shopper is redirected to after finishing checkout?
      instructions:
      - text: Create a checkout session for merchant {merchant_code} in {lang} with payment {payment}.
        slots:
          merchant_code: requestBody.merchant_code
          lang: requestBody.lang
          payment: requestBody.payment
      - text: Open a new checkout session for {payment} and send the shopper back to {merchant_urls} when done.
        slots:
          payment: requestBody.payment
          merchant_urls: requestBody.merchant_urls
      - text: Start a checkout session reusing the saved customer token {token}.
        slots:
          token: requestBody.token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/checkout/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up an existing checkout session
      effect: read
      questions:
      - How can I fetch a checkout session I already created to get its token?
      - What does an existing checkout session look like when I retrieve it by its ID?
      instructions:
      - text: Retrieve checkout session {id}.
        slots:
          id: path.id
      - text: Get the customer token from existing checkout session {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'