Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for HRIS Subpackage Companies API

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

$.paths['/hris/v1/companies/{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 Companies API
  version: 1.0.0
extends: openapi/merge-subpackage-companies-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/companies'].get
  update:
    x-apievangelist-phrasing:
      intent: List companies in the HRIS
      effect: read
      questions:
      - Which legal entities or companies are set up in a customer's HR system?
      - Can I get HRIS companies changed since my last sync?
      instructions:
      - text: List HRIS companies for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Show HR companies modified after {modified_after}.
        slots:
          modified_after: query.modified_after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hris/v1/companies/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company from the HRIS
      effect: read
      questions:
      - What legal name and EINs are recorded for one company in the HR system?
      - Can I see the raw remote data for a single HRIS company?
      instructions:
      - text: Get HRIS company {id}.
        slots:
          id: path.id
      - text: Fetch HR company {id} with its remote data.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'