ThriveCart · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThriveCart Learn API

2 actions 2 updates phrasing extends openapi/thrivecart-learn-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 2

$.info

$.paths['/students'].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 ThriveCart Learn API
  version: 1.0.0
extends: openapi/thrivecart-learn-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: 1
- target: $.paths['/students'].post
  update:
    x-apievangelist-phrasing:
      intent: Enroll a new student in a course
      effect: write
      questions:
      - How do I give someone access to a course in my Learn area?
      - Can I tie a new student's enrollment to an existing order?
      - Do I get a sign-in link back when I enroll a student?
      instructions:
      - text: Enroll {email} as a student in course {course_id}.
        slots:
          email: requestBody.email
          course_id: requestBody.course_id
      - text: Add student {name} ({email}) to course {course_id} and tag them {tags}.
        slots:
          name: requestBody.name
          email: requestBody.email
          course_id: requestBody.course_id
          tags: requestBody.tags[]
      - text: Grant {email} access to course {course_id} linked to order {order_id}.
        slots:
          email: requestBody.email
          course_id: requestBody.course_id
          order_id: requestBody.order_info[order_id]
      method: generated
      generated: '2026-10-01'