Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for HRIS Subpackage Benefits API

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

$.paths['/hris/v1/benefits/{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 Benefits API
  version: 1.0.0
extends: openapi/merge-subpackage-benefits-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/benefits'].get
  update:
    x-apievangelist-phrasing:
      intent: List employee benefit enrollments
      effect: read
      questions:
      - Which benefits is a particular employee enrolled in?
      - Can I list all benefit enrollments changed since last payroll?
      instructions:
      - text: List benefits for employee {employee_id}.
        slots:
          employee_id: query.employee_id
      - text: Show benefit enrollments modified after {modified_after}.
        slots:
          modified_after: query.modified_after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hris/v1/benefits/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an employee benefit enrollment
      effect: read
      questions:
      - What does one employee's benefit enrollment record contain?
      - How do I fetch a single benefit record with the employee expanded?
      instructions:
      - text: Get benefit {id}.
        slots:
          id: path.id
      - text: Fetch benefit enrollment {id} expanding {expand}.
        slots:
          id: path.id
          expand: query.expand
      method: generated
      generated: '2026-09-26'