Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for HRIS Subpackage Payroll Runs API

3 actions 3 updates phrasing extends openapi/merge-subpackage-payrollruns-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/payroll-runs'].get
$.paths['/hris/v1/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 Payroll Runs API
  version: 1.0.0
extends: openapi/merge-subpackage-payrollruns-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/payroll-runs'].get
  update:
    x-apievangelist-phrasing:
      intent: List company payroll runs
      effect: read
      questions:
      - How do I get the payroll runs a company has processed in its payroll system?
      - Can I list only off-cycle or regular payroll runs?
      - Which payroll runs ended within a given date range?
      instructions:
      - text: List payroll runs of type {run_type}.
        slots:
          run_type: query.run_type
      - text: Show payroll runs that ended between {ended_after} and {ended_before}.
        slots:
          ended_after: query.ended_after
          ended_before: query.ended_before
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hris/v1/payroll-runs/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one company payroll run
      effect: read
      questions:
      - Can I read the dates and status of a single payroll run?
      - What does one company-level payroll run record include?
      instructions:
      - text: Get payroll run {id}.
        slots:
          id: path.id
      - text: Fetch company payroll run {id} with original enum values.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'