Bindbee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bindbee Courses API

3 actions 3 updates phrasing extends openapi/bindbee-courses-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/courses'].get

$.paths['/api/lms/v1/courses/{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 Courses API
  version: 1.0.0
extends: openapi/bindbee-courses-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/courses'].get
  update:
    x-apievangelist-phrasing:
      intent: List training courses
      effect: read
      questions:
      - Which courses are available in our learning platform?
      - Can I find courses taught by a given instructor or covering a skill?
      instructions:
      - text: List courses with status {status}.
        slots:
          status: query.status
      - text: Show courses taught by instructor {instructors}.
        slots:
          instructors: query.instructors
      - text: Find courses in category {categories} that teach skill {skills}.
        slots:
          categories: query.categories
          skills: query.skills
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/lms/v1/courses/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one training course
      effect: read
      questions:
      - What does a single course record include?
      - Can I expand a course's contents when I fetch it?
      instructions:
      - text: Get course {id}.
        slots:
          id: path.id
      - text: Retrieve course {id} and expand {expand}.
        slots:
          id: path.id
          expand: query.expand
      method: generated
      generated: '2026-09-26'