Bindbee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bindbee Time Off API

6 actions 6 updates phrasing extends openapi/bindbee-time-off-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 6

$.info
$.paths['/api/hris/v1/time-off'].get
$.paths['/api/hris/v1/time-off'].post
$.paths['/api/hris/v1/time-off/meta/post'].get
$.paths['/api/hris/v1/time-off/{id}'].get
$.paths['/hris/time-off'].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 Time Off API
  version: 1.0.0
extends: openapi/bindbee-time-off-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: 5
- target: $.paths['/api/hris/v1/time-off'].get
  update:
    x-apievangelist-phrasing:
      intent: List time-off requests
      effect: read
      questions:
      - Which vacation or leave requests has an employee submitted?
      - Can I filter time-off requests by status such as approved or pending?
      instructions:
      - text: List time-off requests for employee {employee_id}.
        slots:
          employee_id: query.employee_id
      - text: Show time-off requests with status {status}.
        slots:
          status: query.status
      - text: Find time-off requests modified after {modified_after}.
        slots:
          modified_after: query.modified_after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/hris/v1/time-off'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a time-off request
      effect: write
      questions:
      - How do I file a leave request for an employee in the HR system?
      - Can I retry creating a time-off request without duplicating it?
      instructions:
      - text: Create a time-off request with idempotency key {idempotency_key}.
        slots:
          idempotency_key: header.x-idempotency-key
      - text: Submit a new leave request on connector {connector}.
        slots:
          connector: header.x-connector-token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/hris/v1/time-off/meta/post'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the time-off request schema
      effect: read
      questions:
      - What fields does creating a time-off request need for this HRIS?
      - Can I see the POST time-off schema before submitting leave?
      instructions:
      - text: Get the time-off request schema for connector {connector}.
        slots:
          connector: header.x-connector-token
      - text: Show the fields needed to submit a leave request.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/hris/v1/time-off/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one time-off request
      effect: read
      questions:
      - What are the dates and status of one leave request?
      - Can I fetch a single time-off request by id on the v1 route?
      instructions:
      - text: Get time-off request {id}.
        slots:
          id: path.id
      - text: Retrieve leave request {id} and expand {expand}.
        slots:
          id: path.id
          expand: query.expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hris/time-off'].get
  update:
    x-apievangelist-phrasing:
      intent: List time off and balances on the short route
      effect: read
      questions:
      - Can I get both time-off requests and balances in one call from the simple route?
      - What leave and remaining balance does an employee have on the short time-off route?
      instructions:
      - text: List time off and balances for employee {employee_id} on the short route.
        slots:
          employee_id: query.employee_id
      - text: Show time-off requests together with balances from the HR system.
      method: generated
      generated: '2026-09-26'