Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for HRIS Subpackage Dependents API

3 actions 3 updates phrasing extends openapi/merge-subpackage-dependents-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/dependents'].get
$.paths['/hris/v1/dependents/{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 Dependents API
  version: 1.0.0
extends: openapi/merge-subpackage-dependents-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/dependents'].get
  update:
    x-apievangelist-phrasing:
      intent: List employee dependents
      effect: read
      questions:
      - Who are the dependents on file for a given employee?
      - Can I include sensitive fields when listing dependents?
      instructions:
      - text: List dependents of employee {employee_id}.
        slots:
          employee_id: query.employee_id
      - text: Show dependents created after {created_after}.
        slots:
          created_after: query.created_after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hris/v1/dependents/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an employee dependent
      effect: read
      questions:
      - How do I retrieve one dependent's record from the HR system?
      - Can I see a single dependent's sensitive fields?
      instructions:
      - text: Get dependent {id}.
        slots:
          id: path.id
      - text: Fetch dependent {id} including sensitive fields set to {include_sensitive_fields}.
        slots:
          id: path.id
          include_sensitive_fields: query.include_sensitive_fields
      method: generated
      generated: '2026-09-26'