Remote · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Remote Payroll and Billing Expenses API

8 actions 8 updates phrasing extends openapi/remote-com-expenses-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 8

$.info
$.paths['/expenses'].get
$.paths['/expenses'].post
$.paths['/expenses/{expense_id}'].get
$.paths['/expenses/{expense_id}'].delete
$.paths['/expenses/{expense_id}'].patch
$.paths['/expenses/{expense_id}/approve'].post
$.paths['/expenses/{expense_id}/decline'].post

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 Remote Payroll and Billing Expenses API
  version: 1.0.0
extends: openapi/remote-com-expenses-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: 7
- target: $.paths['/expenses'].get
  update:
    x-apievangelist-phrasing:
      intent: List expenses
      effect: read
      questions:
      - Which expense claims are waiting for approval?
      - Can I see all expenses one employee has submitted?
      instructions:
      - text: List expenses with status {status}.
        slots:
          status: query.status
      - text: Show the expenses of employment {employment_id}.
        slots:
          employment_id: query.employment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/expenses'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit an expense for an employee
      effect: write
      questions:
      - How do I record a reimbursable expense on behalf of an employee?
      - Can I attach a receipt link when creating an expense?
      instructions:
      - text: Add a {category} expense of {amount} {currency} on {expense_date} for employment {employment_id}.
        slots:
          category: requestBody.category
          amount: requestBody.amount
          currency: requestBody.currency
          expense_date: requestBody.expense_date
          employment_id: requestBody.employment_id
      - text: Log {amount} {currency} spent on {expense_date} ({category}) by {employment_id} with receipt {receipt_url}.
        slots:
          amount: requestBody.amount
          currency: requestBody.currency
          expense_date: requestBody.expense_date
          category: requestBody.category
          employment_id: requestBody.employment_id
          receipt_url: requestBody.receipt_url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/expenses/{expense_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View an expense
      effect: read
      questions:
      - What is the status of a specific expense claim?
      - How do I look up one expense by id?
      instructions:
      - text: Show expense {expense_id}.
        slots:
          expense_id: path.expense_id
      - text: Get the details of expense {expense_id}.
        slots:
          expense_id: path.expense_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/expenses/{expense_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an expense
      effect: destructive
      questions:
      - How do I remove an expense that was submitted by mistake?
      - Can an expense claim be deleted?
      instructions:
      - text: Delete expense {expense_id}.
        slots:
          expense_id: path.expense_id
      - text: Remove the duplicate expense {expense_id}.
        slots:
          expense_id: path.expense_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/expenses/{expense_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit an existing expense
      effect: write
      questions:
      - Can I fix the amount or category on an expense already submitted?
      - How do I correct the date on an existing expense claim?
      instructions:
      - text: Change expense {expense_id} to {amount} {currency}.
        slots:
          expense_id: path.expense_id
          amount: requestBody.amount
          currency: requestBody.currency
      - text: 'Edit expense {expense_id}: category {category}, date {expense_date}.'
        slots:
          expense_id: path.expense_id
          category: requestBody.category
          expense_date: requestBody.expense_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/expenses/{expense_id}/approve'].post
  update:
    x-apievangelist-phrasing:
      intent: Approve an expense
      effect: write
      questions:
      - How do I approve an employee's expense so it gets reimbursed?
      - Can I sign off on an expense claim through the API?
      instructions:
      - text: Approve expense {expense_id}.
        slots:
          expense_id: path.expense_id
      - text: Sign off on expense claim {expense_id}.
        slots:
          expense_id: path.expense_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/expenses/{expense_id}/decline'].post
  update:
    x-apievangelist-phrasing:
      intent: Decline an expense with a reason
      effect: write
      questions:
      - How do I reject an expense claim and explain why?
      - Is a reason required when declining an expense?
      instructions:
      - text: Decline expense {expense_id} because {reason}.
        slots:
          expense_id: path.expense_id
          reason: requestBody.reason
      - text: Reject expense claim {expense_id} with the note {reason}.
        slots:
          expense_id: path.expense_id
          reason: requestBody.reason
      method: generated
      generated: '2026-09-26'