Bindbee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bindbee Compensation API

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

$.paths['/api/hris/v1/compensations/{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 Compensation API
  version: 1.0.0
extends: openapi/bindbee-compensation-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/compensations'].get
  update:
    x-apievangelist-phrasing:
      intent: List employee compensation records
      effect: read
      questions:
      - What is a given employee's pay rate history?
      - Can I list compensation records for everyone in one pay group?
      - Which pay changes started within a date range?
      instructions:
      - text: List compensation for employee {employee_id}.
        slots:
          employee_id: query.employee_id
      - text: Show compensation records in pay group {pay_group_id}.
        slots:
          pay_group_id: query.pay_group_id
      - text: Find compensation changes starting between {start_date_from} and {start_date_to}.
        slots:
          start_date_from: query.start_date_from
          start_date_to: query.start_date_to
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/hris/v1/compensations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one compensation record
      effect: read
      questions:
      - What does a single compensation entry include?
      - Can I look up one pay rate record by id?
      instructions:
      - text: Get compensation record {id}.
        slots:
          id: path.id
      - text: Open compensation {id} with raw upstream data.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'