Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for HRIS Subpackage Time Off API

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

$.info
$.paths['/hris/v1/time-off'].get
$.paths['/hris/v1/time-off'].post
$.paths['/hris/v1/time-off/{id}'].get
$.paths['/hris/v1/time-off/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 HRIS Subpackage Time Off API
  version: 1.0.0
extends: openapi/merge-subpackage-timeoff-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: 4
- target: $.paths['/hris/v1/time-off'].get
  update:
    x-apievangelist-phrasing:
      intent: List time off requests
      effect: read
      questions:
      - Who has approved time off next week?
      - Can I list pending vacation requests for one employee?
      - Which time off requests does a particular manager need to approve?
      instructions:
      - text: List time off for employee {employee_id} with status {status}.
        slots:
          employee_id: query.employee_id
          status: query.status
      - text: Show time off starting after {started_after} and ending before {ended_before}.
        slots:
          started_after: query.started_after
          ended_before: query.ended_before
      - text: List {request_type} requests awaiting approver {approver_id}.
        slots:
          request_type: query.request_type
          approver_id: query.approver_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hris/v1/time-off'].post
  update:
    x-apievangelist-phrasing:
      intent: Request time off
      effect: write
      questions:
      - How do I submit a leave request into a customer's HR system?
      - Can I book vacation for an employee through the integration?
      instructions:
      - text: Create a time off request with {model}.
        slots:
          model: requestBody.model
      - text: 'Book this leave in the HRIS: {model}.'
        slots:
          model: requestBody.model
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hris/v1/time-off/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a time off request
      effect: read
      questions:
      - What are the dates and status of one time off request?
      - Can I retrieve a leave request with the employee expanded?
      instructions:
      - text: Get time off request {id}.
        slots:
          id: path.id
      - text: Fetch leave request {id} expanding {expand}.
        slots:
          id: path.id
          expand: query.expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hris/v1/time-off/meta/post'].get
  update:
    x-apievangelist-phrasing:
      intent: See which fields a time off request needs
      effect: read
      questions:
      - What fields must a time off request include for this HR platform?
      - How do I check supported leave request fields before creating one?
      instructions:
      - text: Get time off creation metadata for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Show the fields needed to request time off.
      method: generated
      generated: '2026-09-26'