ThriveCart · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThriveCart Bumps API

4 actions 4 updates phrasing extends openapi/thrivecart-bumps-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['/bumps'].get
$.paths['/bumps/{bump_id}'].get
$.paths['/bumps/{bump_id}/pricing_options'].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 ThriveCart Bumps API
  version: 1.0.0
extends: openapi/thrivecart-bumps-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['/bumps'].get
  update:
    x-apievangelist-phrasing:
      intent: List bump offers
      effect: read
      questions:
      - What order bump offers do I have set up?
      - Can I see all my checkout bumps in one list?
      instructions:
      - text: List all my bump offers.
      - text: Show every order bump in my account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/bumps/{bump_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a bump offer
      effect: read
      questions:
      - How do I view the settings of one specific bump offer?
      - Can I look up a single order bump by its ID?
      instructions:
      - text: Get bump offer {bump_id}.
        slots:
          bump_id: path.bump_id
      - text: Show me the details of order bump {bump_id}.
        slots:
          bump_id: path.bump_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/bumps/{bump_id}/pricing_options'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a bump offer's pricing options
      effect: read
      questions:
      - What pricing options are configured on a bump offer?
      - How much does a particular order bump cost?
      instructions:
      - text: Get the pricing options for bump {bump_id}.
        slots:
          bump_id: path.bump_id
      - text: Show the price details of order bump {bump_id}.
        slots:
          bump_id: path.bump_id
      method: generated
      generated: '2026-10-01'