Bindbee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bindbee Employees API

3 actions 3 updates phrasing extends openapi/bindbee-employees-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['/hris/employees'].get
$.paths['/hris/employees/{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 Employees API
  version: 1.0.0
extends: openapi/bindbee-employees-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['/hris/employees'].get
  update:
    x-apievangelist-phrasing:
      intent: Page through employees on the short route
      effect: read
      questions:
      - Can I page through all employees using the simple /hris/employees route?
      - What normalized employee list comes back from the connected HR system?
      instructions:
      - text: List employees, {page_size} per page.
        slots:
          page_size: query.page_size
      - text: Get the next page of employees after cursor {cursor}.
        slots:
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hris/employees/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an employee on the short route
      effect: read
      questions:
      - Can I look up one employee by id on the simple HRIS employees route?
      - What normalized fields does a single employee record return?
      instructions:
      - text: Look up employee record {id} on the short HRIS route.
        slots:
          id: path.id
      - text: Fetch normalized employee {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'