ThriveCart · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThriveCart Products API

4 actions 4 updates phrasing extends openapi/thrivecart-products-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/products'].get

$.paths['/products/{product_id}'].get

$.paths['/products/{product_id}/pricing_options'].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 ThriveCart Products API
  version: 1.0.0
extends: openapi/thrivecart-products-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/products'].get
  update:
    x-apievangelist-phrasing:
      intent: List products
      effect: read
      questions:
      - What products do I have in my account?
      - Can I pull a list of all my products?
      instructions:
      - text: List all my products.
      - text: Show every product in my store.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/products/{product_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a product
      effect: read
      questions:
      - How do I look up one product's details?
      - Can I fetch a product by its ID?
      instructions:
      - text: Get product {product_id}.
        slots:
          product_id: path.product_id
      - text: Show me the details of product {product_id}.
        slots:
          product_id: path.product_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/products/{product_id}/pricing_options'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a product's pricing options
      effect: read
      questions:
      - What pricing options are available for a product?
      - Can I see the commission a specific affiliate would earn on a product?
      instructions:
      - text: Get the pricing options for product {product_id}.
        slots:
          product_id: path.product_id
      - text: Show pricing for product {product_id} with commissions for affiliate {affiliate_id}.
        slots:
          product_id: path.product_id
          affiliate_id: query.affiliate_id
      method: generated
      generated: '2026-10-01'