Bindbee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bindbee Location API

3 actions 3 updates phrasing extends openapi/bindbee-location-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/locations'].get
$.paths['/api/hris/v1/locations/{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 Location API
  version: 1.0.0
extends: openapi/bindbee-location-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/locations'].get
  update:
    x-apievangelist-phrasing:
      intent: List work locations
      effect: read
      questions:
      - Which office and work locations are set up in the HR system?
      - Can I see locations updated recently?
      instructions:
      - text: List locations modified after {modified_after}.
        slots:
          modified_after: query.modified_after
      - text: Show every work location in the HRIS.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/hris/v1/locations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one work location
      effect: read
      questions:
      - What address details does one location have?
      - Can I fetch a single work location by id?
      instructions:
      - text: Get location {id}.
        slots:
          id: path.id
      - text: Retrieve work location {id} with raw data.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'