Bindbee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bindbee Users API

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

$.paths['/api/lms/v1/users/{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 Users API
  version: 1.0.0
extends: openapi/bindbee-users-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/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List learners in the LMS
      effect: read
      questions:
      - Which learners have accounts in our learning platform?
      - Can I find an LMS user by email address?
      instructions:
      - text: Find the LMS user with email {email_address}.
        slots:
          email_address: query.email_address
      - text: List LMS users with status {status}.
        slots:
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/lms/v1/users/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one LMS learner
      effect: read
      questions:
      - What profile details does the LMS hold for one learner?
      - Can I fetch a single learning platform user by id?
      instructions:
      - text: Get LMS user {id}.
        slots:
          id: path.id
      - text: Retrieve learner {id} with raw data.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'