Bindbee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bindbee Company API

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

$.paths['/api/hris/v1/companies/{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 Company API
  version: 1.0.0
extends: openapi/bindbee-company-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/companies'].get
  update:
    x-apievangelist-phrasing:
      intent: List companies in the HRIS
      effect: read
      questions:
      - Which legal entities or companies are set up in the connected HRIS?
      - Can I see companies updated after a certain time?
      instructions:
      - text: List companies modified after {modified_after}.
        slots:
          modified_after: query.modified_after
      - text: Show all companies from the HR system.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/hris/v1/companies/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one company by id
      effect: read
      questions:
      - What information is held for a single company entity?
      - Can I fetch one company record with custom fields?
      instructions:
      - text: Get company {id}.
        slots:
          id: path.id
      - text: Retrieve company {id} including custom fields.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'