Bindbee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bindbee Completions API

3 actions 3 updates phrasing extends openapi/bindbee-completions-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/completions'].get
$.paths['/api/lms/v1/completions/{id}'].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 Bindbee Completions API
  version: 1.0.0
extends: openapi/bindbee-completions-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/completions'].get
  update:
    x-apievangelist-phrasing:
      intent: List course completions
      effect: read
      questions:
      - Who has completed a given training course?
      - Can I see completions for one learner with their grade?
      - Which completions happened within a date window?
      instructions:
      - text: List completions for course {course}.
        slots:
          course: query.course
      - text: Show course completions for learner {user}.
        slots:
          user: query.user
      - text: Find completions finished between {completed_at_from} and {completed_at_to}.
        slots:
          completed_at_from: query.completed_at_from
          completed_at_to: query.completed_at_to
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/lms/v1/completions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one course completion
      effect: read
      questions:
      - What details are recorded for one course completion?
      - Can I fetch a single completion record by id?
      instructions:
      - text: Get completion {id}.
        slots:
          id: path.id
      - text: Retrieve completion record {id} with custom fields.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'