Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for HRIS Subpackage Time Off Balances API

3 actions 3 updates phrasing extends openapi/merge-subpackage-timeoffbalances-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Merge's API. It is a proposal applied on top of the contract, not a document Merge publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/hris/v1/time-off-balances'].get
$.paths['/hris/v1/time-off-balances/{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 HRIS Subpackage Time Off Balances API
  version: 1.0.0
extends: openapi/merge-subpackage-timeoffbalances-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['/hris/v1/time-off-balances'].get
  update:
    x-apievangelist-phrasing:
      intent: List employee time off balances
      effect: read
      questions:
      - How much vacation or sick time does each employee have left in the HR system?
      - Can I get the time off balances for one employee?
      - Which balances belong to a particular policy type, like vacation?
      instructions:
      - text: List time off balances for employee {employee_id}.
        slots:
          employee_id: query.employee_id
      - text: Show balances with policy type {policy_type}.
        slots:
          policy_type: query.policy_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hris/v1/time-off-balances/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one time off balance
      effect: read
      questions:
      - Can I read a single time off balance record by id?
      - What does one employee's leave balance record include?
      instructions:
      - text: Get time off balance {id}.
        slots:
          id: path.id
      - text: Fetch leave balance {id} with {relations} expanded.
        slots:
          id: path.id
          relations: query.expand
      method: generated
      generated: '2026-09-26'