Bindbee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bindbee Group API

3 actions 3 updates phrasing extends openapi/bindbee-group-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/groups'].get
$.paths['/api/hris/v1/groups/{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 Group API
  version: 1.0.0
extends: openapi/bindbee-group-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/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List HRIS groups and teams
      effect: read
      questions:
      - Which teams, divisions or cost centers exist in the HR system?
      - Can I list the child groups under a parent group?
      instructions:
      - text: List groups under parent group {parent_group_id}.
        slots:
          parent_group_id: query.parent_group_id
      - text: Show HRIS groups of type {type}.
        slots:
          type: query.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/hris/v1/groups/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one HRIS group
      effect: read
      questions:
      - What details are held for one team or group?
      - Can I fetch a single group by id?
      instructions:
      - text: Get group {id}.
        slots:
          id: path.id
      - text: Retrieve HRIS group {id} with raw data.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'