# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Bindbee Employee API
  version: 1.0.0
extends: openapi/bindbee-employee-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/employees'].get
  update:
    x-apievangelist-phrasing:
      intent: Search employees in the HRIS
      effect: read
      questions:
      - Who reports to a given manager according to the HR system?
      - Can I find an employee by work email or employee number?
      - Which employees are active, and can I filter by work location or pay group?
      instructions:
      - text: List employees who report to manager {manager_id}.
        slots:
          manager_id: query.manager_id
      - text: Find the employee with work email {work_email}.
        slots:
          work_email: query.work_email
      - text: Show employees with employment status {employment_status} at location {work_locations}.
        slots:
          employment_status: query.employment_status
          work_locations: query.work_locations
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/hris/v1/employees'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a new employee to the HRIS
      effect: write
      questions:
      - How do I create a new hire record in the connected HR system?
      - Can I retry an employee creation safely without making duplicates?
      instructions:
      - text: Create a new employee in the HRIS using idempotency key {idempotency_key}.
        slots:
          idempotency_key: header.x-idempotency-key
      - text: Add a new hire to the HR system on connector {connector}.
        slots:
          connector: header.x-connector-token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/hris/v1/employees/create/meta'].get
  update:
    x-apievangelist-phrasing:
      intent: Get data points needed to add an employee
      effect: read
      questions:
      - Which data points does this HR system need before I can add a new employee?
      - What does the create/meta endpoint list as required for a new hire?
      instructions:
      - text: List the data points required to add an employee on connector {connector}.
        slots:
          connector: header.x-connector-token
      - text: Show the new-hire data points this HRIS integration requires.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/hris/v1/employees/meta/post'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the POST employee request schema
      effect: read
      questions:
      - What is the exact request schema for the POST employee call?
      - Can I fetch the JSON schema for creating employees from the meta/post endpoint?
      instructions:
      - text: Get the POST employee request schema for connector {connector}.
        slots:
          connector: header.x-connector-token
      - text: Fetch the employee creation request schema from meta/post.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/hris/v1/employees/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one employee by id
      effect: read
      questions:
      - What does the HR system hold for one specific employee?
      - Can I expand an employee's manager or employments when I fetch them?
      instructions:
      - text: Get employee {id}.
        slots:
          id: path.id
      - text: Retrieve employee {id} and expand {expand}.
        slots:
          id: path.id
          expand: query.expand
      method: generated
      generated: '2026-09-26'