Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Merge Subpackage Employees API

7 actions 7 updates phrasing extends openapi/merge-subpackage-employees-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 7

$.info
$.paths['/accounting/v1/employees'].get
$.paths['/accounting/v1/employees/{id}'].get
$.paths['/hris/v1/employees'].get
$.paths['/hris/v1/employees/{id}'].get
$.paths['/hris/v1/employees/ignore/{model_id}'].post
$.paths['/hris/v1/employees/meta/post'].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 Merge Subpackage Employees API
  version: 1.0.0
extends: openapi/merge-subpackage-employees-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: 6
- target: $.paths['/accounting/v1/employees'].get
  update:
    x-apievangelist-phrasing:
      intent: List employees recorded in the accounting system
      effect: read
      questions:
      - How do I get the staff list that lives in a customer's accounting software?
      - Can I list accounting employees for just one company?
      instructions:
      - text: List accounting-side employees for company {company_id}.
        slots:
          company_id: query.company_id
      - text: Show employees from the ledger modified after {modified_after}.
        slots:
          modified_after: query.modified_after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/employees/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one employee from the accounting system
      effect: read
      questions:
      - Can I read a single employee record stored in the accounting platform?
      - What does an accounting employee record contain?
      instructions:
      - text: Get accounting employee {id}.
        slots:
          id: path.id
      - text: Fetch ledger employee {id} with {relations} expanded.
        slots:
          id: path.id
          relations: query.expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hris/v1/employees'].get
  update:
    x-apievangelist-phrasing:
      intent: List employees from the HR system
      effect: read
      questions:
      - How do I pull the employee directory from my customer's HRIS?
      - Can I find employees who were terminated within a date range?
      - Which HR employees report to a given manager or sit on a given team?
      instructions:
      - text: List HRIS employees reporting to manager {manager_id}.
        slots:
          manager_id: query.manager_id
      - text: Find the employee with work email {work_email}.
        slots:
          work_email: query.work_email
      - text: Show employees with employment status {employment_status} who started after {started_after}.
        slots:
          employment_status: query.employment_status
          started_after: query.started_after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hris/v1/employees/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one employee from the HR system
      effect: read
      questions:
      - How do I read one person's full HRIS profile?
      - Can I include sensitive fields like social security numbers for a single employee?
      instructions:
      - text: Get HRIS employee {id}.
        slots:
          id: path.id
      - text: Fetch HR employee {id} including sensitive fields.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hris/v1/employees/ignore/{model_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop syncing an HRIS employee
      effect: destructive
      questions:
      - How do I exclude one employee's record from future HR syncs?
      - What happens to an employee's data once it is ignored?
      instructions:
      - text: Ignore HRIS employee {model_id} for reason {reason}.
        slots:
          model_id: path.model_id
          reason: requestBody.reason
      - text: Stop syncing employee {model_id}, noting {message}.
        slots:
          model_id: path.model_id
          message: requestBody.message
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hris/v1/employees/meta/post'].get
  update:
    x-apievangelist-phrasing:
      intent: See which fields creating an HRIS employee takes
      effect: read
      questions:
      - What fields does the HR platform require to create a new hire?
      - Can I read the employee create schema before posting one?
      instructions:
      - text: Show HRIS employee creation fields for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Get the new-hire create metadata.
      method: generated
      generated: '2026-09-26'