Remote · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Remote Time and Attendance Timesheets API

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

$.info
$.paths['/timesheets'].get
$.paths['/timesheets/{timesheet_id}'].get
$.paths['/timesheets/{timesheet_id}/approve'].post
$.paths['/timesheets/{timesheet_id}/send_back'].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 Time and Attendance Timesheets API
  version: 1.0.0
extends: openapi/remote-com-timesheets-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['/timesheets'].get
  update:
    x-apievangelist-phrasing:
      intent: List timesheets
      effect: read
      questions:
      - Which timesheets are waiting for my approval?
      - Can I list timesheets for a given period start?
      instructions:
      - text: List timesheets with status {status}.
        slots:
          status: query.status
      - text: Show timesheets for employment {employment_id} starting {period_start}.
        slots:
          employment_id: query.employment_id
          period_start: query.period_start
      method: generated
      generated: '2026-09-26'
- target: $.paths['/timesheets/{timesheet_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a timesheet
      effect: read
      questions:
      - How many hours were logged on a specific timesheet?
      - How do I open one timesheet?
      instructions:
      - text: Show timesheet {timesheet_id}.
        slots:
          timesheet_id: path.timesheet_id
      - text: Get the hours on timesheet {timesheet_id}.
        slots:
          timesheet_id: path.timesheet_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/timesheets/{timesheet_id}/approve'].post
  update:
    x-apievangelist-phrasing:
      intent: Approve a timesheet
      effect: write
      questions:
      - How do I approve submitted hours so they go to payroll?
      - Can I approve a timesheet via the API?
      instructions:
      - text: Approve timesheet {timesheet_id}.
        slots:
          timesheet_id: path.timesheet_id
      - text: Sign off on the hours in timesheet {timesheet_id}.
        slots:
          timesheet_id: path.timesheet_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/timesheets/{timesheet_id}/send_back'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a timesheet back for revision
      effect: write
      questions:
      - How do I return a timesheet to the employee to fix their hours?
      - Can I ask for corrections on a timesheet with an explanation?
      instructions:
      - text: Send timesheet {timesheet_id} back because {reason}.
        slots:
          timesheet_id: path.timesheet_id
          reason: requestBody.reason
      - text: Return timesheet {timesheet_id} for revision with the note {reason}.
        slots:
          timesheet_id: path.timesheet_id
          reason: requestBody.reason
      method: generated
      generated: '2026-09-26'