Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for HRIS Subpackage Employee Payroll Runs API

3 actions 3 updates phrasing extends openapi/merge-subpackage-employeepayrollruns-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/employee-payroll-runs'].get
$.paths['/hris/v1/employee-payroll-runs/{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 Employee Payroll Runs API
  version: 1.0.0
extends: openapi/merge-subpackage-employeepayrollruns-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/employee-payroll-runs'].get
  update:
    x-apievangelist-phrasing:
      intent: List employee payroll runs (paystubs)
      effect: read
      questions:
      - How do I get individual employees' pay results from an HR or payroll system?
      - Can I list one employee's payroll runs within a date range?
      - Which employees were paid in a specific payroll run?
      instructions:
      - text: List payroll runs for employee {employee_id} started after {started_after}.
        slots:
          employee_id: query.employee_id
          started_after: query.started_after
      - text: Show every employee's pay results in payroll run {payroll_run_id}.
        slots:
          payroll_run_id: query.payroll_run_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hris/v1/employee-payroll-runs/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one employee payroll run
      effect: read
      questions:
      - Can I read a single employee's paystub-level payroll record?
      - What does one employee payroll run include?
      instructions:
      - text: Get employee payroll run {id}.
        slots:
          id: path.id
      - text: Fetch employee payroll run {id} with {relations} expanded.
        slots:
          id: path.id
          relations: query.expand
      method: generated
      generated: '2026-09-26'