Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for HRIS Subpackage Bank Info API

3 actions 3 updates phrasing extends openapi/merge-subpackage-bankinfo-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/bank-info'].get
$.paths['/hris/v1/bank-info/{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 Bank Info API
  version: 1.0.0
extends: openapi/merge-subpackage-bankinfo-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/hris/v1/bank-info'].get
  update:
    x-apievangelist-phrasing:
      intent: List employee bank accounts
      effect: read
      questions:
      - How do I list all employees' direct deposit bank accounts from an HR system?
      - Can I filter employee bank info to savings or checking accounts?
      - Can I list every bank account on file for a given employee?
      instructions:
      - text: List bank accounts for employee {employee_id}.
        slots:
          employee_id: query.employee_id
      - text: Show employee bank info with account type {account_type} at bank {bank_name}.
        slots:
          account_type: query.account_type
          bank_name: query.bank_name
      method: generated
      generated: '2026-10-02'
- target: $.paths['/hris/v1/bank-info/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one employee bank account
      effect: read
      questions:
      - Can I read a single employee bank account record by id?
      - What details does one BankInfo record include?
      instructions:
      - text: Get the single bank info record {id}.
        slots:
          id: path.id
      - text: Fetch employee bank account {id} with {relations} expanded.
        slots:
          id: path.id
          relations: query.expand
      method: generated
      generated: '2026-10-02'