Bindbee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bindbee Benefit Coverages API

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

$.paths['/api/hris/v1/benefit-coverages/{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 Benefit Coverages API
  version: 1.0.0
extends: openapi/bindbee-benefit-coverages-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/benefit-coverages'].get
  update:
    x-apievangelist-phrasing:
      intent: List benefit coverage levels
      effect: read
      questions:
      - What coverage options exist under a given benefit?
      - Can I see coverage records that changed recently?
      instructions:
      - text: List coverages for benefit {benefit_id}.
        slots:
          benefit_id: query.benefit_id
      - text: Show benefit coverages modified after {modified_after}.
        slots:
          modified_after: query.modified_after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/hris/v1/benefit-coverages/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one benefit coverage record
      effect: read
      questions:
      - What does one benefit coverage entry include?
      - Can I retrieve a single coverage tier record by id?
      instructions:
      - text: Get benefit coverage {id}.
        slots:
          id: path.id
      - text: Fetch coverage record {id} including raw data.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'