Bindbee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bindbee Employments API

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

$.paths['/api/hris/v1/employments/{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 Employments API
  version: 1.0.0
extends: openapi/bindbee-employments-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/employments'].get
  update:
    x-apievangelist-phrasing:
      intent: List employment records
      effect: read
      questions:
      - What job titles and employment history does an employee have?
      - Can I filter employments by type such as full-time or contractor?
      instructions:
      - text: List employment records for employee {employee_id}.
        slots:
          employee_id: query.employee_id
      - text: Show {employment_type} employments.
        slots:
          employment_type: query.employment_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/hris/v1/employments/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one employment record
      effect: read
      questions:
      - What does one employment record contain?
      - Can I fetch a single job/position record by id?
      instructions:
      - text: Get employment {id}.
        slots:
          id: path.id
      - text: Retrieve employment record {id} with custom fields.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'