Bindbee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bindbee Timesheet Entry API

5 actions 5 updates phrasing extends openapi/bindbee-timesheet-entry-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 5

$.info
$.paths['/api/hris/v1/timesheet-entry'].get
$.paths['/api/hris/v1/timesheet-entry'].post
$.paths['/api/hris/v1/timesheet-entry/meta/post'].get
$.paths['/api/hris/v1/timesheet-entry/{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 Timesheet Entry API
  version: 1.0.0
extends: openapi/bindbee-timesheet-entry-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: 4
- target: $.paths['/api/hris/v1/timesheet-entry'].get
  update:
    x-apievangelist-phrasing:
      intent: List timesheet entries
      effect: read
      questions:
      - What hours has an employee logged on their timesheet?
      - Can I find timesheet entries that started within a time window?
      instructions:
      - text: List timesheet entries for employee {employee_id}.
        slots:
          employee_id: query.employee_id
      - text: Show timesheet entries starting between {start_time_from} and {start_time_to}.
        slots:
          start_time_from: query.start_time_from
          start_time_to: query.start_time_to
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/hris/v1/timesheet-entry'].post
  update:
    x-apievangelist-phrasing:
      intent: Log a timesheet entry
      effect: write
      questions:
      - How do I record hours worked for an employee?
      - Can I retry a timesheet submission safely with an idempotency key?
      instructions:
      - text: Create a timesheet entry with idempotency key {idempotency_key}.
        slots:
          idempotency_key: header.x-idempotency-key
      - text: Log worked hours on connector {connector}.
        slots:
          connector: header.x-connector-token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/hris/v1/timesheet-entry/meta/post'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the timesheet entry request schema
      effect: read
      questions:
      - What fields are required to create a timesheet entry in this HRIS?
      - Can I see the POST timesheet schema before logging hours?
      instructions:
      - text: Get the timesheet entry request schema for connector {connector}.
        slots:
          connector: header.x-connector-token
      - text: Show the fields needed to log a timesheet entry.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/hris/v1/timesheet-entry/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one timesheet entry
      effect: read
      questions:
      - What start and end times are on one timesheet entry?
      - Can I fetch a single timesheet entry by id?
      instructions:
      - text: Get timesheet entry {id}.
        slots:
          id: path.id
      - text: Retrieve timesheet {id} and expand {expand}.
        slots:
          id: path.id
          expand: query.expand
      method: generated
      generated: '2026-09-26'