Bindbee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bindbee Benefits API

3 actions 3 updates phrasing extends openapi/bindbee-benefits-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/benefits'].get
$.paths['/api/hris/v1/benefits/{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 Benefits API
  version: 1.0.0
extends: openapi/bindbee-benefits-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/benefits'].get
  update:
    x-apievangelist-phrasing:
      intent: List employee benefit enrollments
      effect: read
      questions:
      - Which benefits is a given employee enrolled in?
      - Can I filter benefits by plan category or coverage tier?
      - Which benefits became effective within a date range?
      instructions:
      - text: List benefits for employee {employee_id}.
        slots:
          employee_id: query.employee_id
      - text: Show {benefit_plan_category} benefits at coverage tier {coverage_tier}.
        slots:
          benefit_plan_category: query.benefit_plan_category
          coverage_tier: query.coverage_tier
      - text: Find benefits effective between {effective_date_from} and {effective_date_to}.
        slots:
          effective_date_from: query.effective_date_from
          effective_date_to: query.effective_date_to
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/hris/v1/benefits/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one employee benefit by id
      effect: read
      questions:
      - What are the details of one employee's benefit enrollment?
      - Can I pull a single benefit record with its custom fields?
      instructions:
      - text: Get benefit {id}.
        slots:
          id: path.id
      - text: Retrieve employee benefit {id} with custom fields.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'