Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for HRIS Subpackage Employments API

3 actions 3 updates phrasing extends openapi/merge-subpackage-employments-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/employments'].get

$.paths['/hris/v1/employments/{id}'].get

OpenAPI Overlay

# 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 Employments API
  version: 1.0.0
extends: openapi/merge-subpackage-employments-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/employments'].get
  update:
    x-apievangelist-phrasing:
      intent: List employments
      effect: read
      questions:
      - Can I pull job titles and pay rates for employees from the HR system?
      - Which employment records belong to one employee?
      instructions:
      - text: List employments for employee {employee_id}.
        slots:
          employee_id: query.employee_id
      - text: Show employment records ordered by {order_by}.
        slots:
          order_by: query.order_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hris/v1/employments/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an employment
      effect: read
      questions:
      - Can I look up a single employment record by ID?
      - What pay and title details are on one employment?
      instructions:
      - text: Get employment {id}.
        slots:
          id: path.id
      - text: Show me employment record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'