Bindbee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bindbee Dependent Benefits API

3 actions 3 updates phrasing extends openapi/bindbee-dependent-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/dependent-benefits'].get
$.paths['/api/hris/v1/dependent-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 Dependent Benefits API
  version: 1.0.0
extends: openapi/bindbee-dependent-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/dependent-benefits'].get
  update:
    x-apievangelist-phrasing:
      intent: List benefits covering dependents
      effect: read
      questions:
      - Which benefits cover a particular dependent?
      - Can I see dependent benefits under one employer plan?
      - Which dependent coverages end within a date range?
      instructions:
      - text: List benefits for dependent {dependent_id}.
        slots:
          dependent_id: query.dependent_id
      - text: Show dependent benefits under employer plan {employer_benefit_id}.
        slots:
          employer_benefit_id: query.employer_benefit_id
      - text: Find dependent benefits ending between {end_date_from} and {end_date_to}.
        slots:
          end_date_from: query.end_date_from
          end_date_to: query.end_date_to
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/hris/v1/dependent-benefits/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one dependent benefit
      effect: read
      questions:
      - What details are recorded for one dependent's benefit?
      - Can I retrieve a single dependent benefit record by id?
      instructions:
      - text: Get dependent benefit {id}.
        slots:
          id: path.id
      - text: Retrieve dependent benefit record {id} with custom fields.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'