Bindbee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bindbee Enrollments API

3 actions 3 updates phrasing extends openapi/bindbee-enrollments-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/api/lms/v1/enrollments'].get

$.paths['/api/lms/v1/enrollments/{id}'].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 Bindbee Enrollments API
  version: 1.0.0
extends: openapi/bindbee-enrollments-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/lms/v1/enrollments'].get
  update:
    x-apievangelist-phrasing:
      intent: List course enrollments
      effect: read
      questions:
      - Which learners are enrolled in a given course?
      - What courses is one employee enrolled in on the learning platform?
      - Can I find enrollments that started within a date range?
      instructions:
      - text: List enrollments for course {course}.
        slots:
          course: query.course
      - text: Show course enrollments for learner {user}.
        slots:
          user: query.user
      - text: Find enrollments starting between {start_date_from} and {start_date_to}.
        slots:
          start_date_from: query.start_date_from
          start_date_to: query.start_date_to
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/lms/v1/enrollments/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one course enrollment
      effect: read
      questions:
      - What does one LMS enrollment record include?
      - Can I look up a single enrollment by id?
      instructions:
      - text: Get enrollment {id}.
        slots:
          id: path.id
      - text: Retrieve enrollment {id} and expand {expand}.
        slots:
          id: path.id
          expand: query.expand
      method: generated
      generated: '2026-09-26'