Bindbee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bindbee Contents API

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

$.paths['/api/lms/v1/contents/{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 Contents API
  version: 1.0.0
extends: openapi/bindbee-contents-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/contents'].get
  update:
    x-apievangelist-phrasing:
      intent: List learning content items
      effect: read
      questions:
      - What learning content items belong to a given course?
      - Can I filter LMS content by skill, category or language?
      instructions:
      - text: List content in course {courses}.
        slots:
          courses: query.courses
      - text: Show learning content tagged with skill {skills} in language {languages}.
        slots:
          skills: query.skills
          languages: query.languages
      - text: List LMS content with status {status}.
        slots:
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/lms/v1/contents/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one learning content item
      effect: read
      questions:
      - What details are available for one piece of LMS content?
      - Can I fetch a single content item by its id?
      instructions:
      - text: Get LMS content {id}.
        slots:
          id: path.id
      - text: Retrieve content item {id} with raw data.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'