Bindbee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bindbee Time Off Balance API

3 actions 3 updates phrasing extends openapi/bindbee-time-off-balance-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/hris/v1/time-off-balances'].get
$.paths['/api/hris/v1/time-off-balances/{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 Time Off Balance API
  version: 1.0.0
extends: openapi/bindbee-time-off-balance-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/hris/v1/time-off-balances'].get
  update:
    x-apievangelist-phrasing:
      intent: List time-off balances
      effect: read
      questions:
      - How much vacation or sick leave does an employee have left?
      - Can I list leave balances changed since my last sync?
      instructions:
      - text: List time-off balances for employee {employee_id}.
        slots:
          employee_id: query.employee_id
      - text: Show time-off balances modified after {modified_after}.
        slots:
          modified_after: query.modified_after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/hris/v1/time-off-balances/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one time-off balance
      effect: read
      questions:
      - What does a single leave balance record contain?
      - Can I fetch one time-off balance by id?
      instructions:
      - text: Get time-off balance {id}.
        slots:
          id: path.id
      - text: Retrieve leave balance {id} and expand {expand}.
        slots:
          id: path.id
          expand: query.expand
      method: generated
      generated: '2026-09-26'