Remote · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Remote Payroll and Billing Payslips API

3 actions 3 updates phrasing extends openapi/remote-com-payslips-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Remote's API. It is a proposal applied on top of the contract, not a document Remote publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/payslips'].get

$.paths['/payslips/{payslip_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 Remote Payroll and Billing Payslips API
  version: 1.0.0
extends: openapi/remote-com-payslips-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['/payslips'].get
  update:
    x-apievangelist-phrasing:
      intent: List payslips
      effect: read
      questions:
      - Where can I find an employee's payslips?
      - Can I list payslips for a specific pay period?
      instructions:
      - text: List payslips for employment {employment_id}.
        slots:
          employment_id: query.employment_id
      - text: Show all payslips for period {period}.
        slots:
          period: query.period
      method: generated
      generated: '2026-09-26'
- target: $.paths['/payslips/{payslip_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a payslip
      effect: read
      questions:
      - How do I open one payslip to see gross and net pay?
      - What does a single payslip contain?
      instructions:
      - text: Show payslip {payslip_id}.
        slots:
          payslip_id: path.payslip_id
      - text: Get the details of payslip {payslip_id}.
        slots:
          payslip_id: path.payslip_id
      method: generated
      generated: '2026-09-26'