Remote · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Remote Time and Attendance Time Off API

8 actions 8 updates phrasing extends openapi/remote-com-time-off-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['/timeoff'].get
$.paths['/timeoff'].post
$.paths['/timeoff/{timeoff_id}'].get
$.paths['/timeoff/{timeoff_id}'].patch
$.paths['/timeoff/{timeoff_id}/approve'].post
$.paths['/timeoff/{timeoff_id}/decline'].post
$.paths['/timeoff/{timeoff_id}/cancel'].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 Time Off API
  version: 1.0.0
extends: openapi/remote-com-time-off-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['/timeoff'].get
  update:
    x-apievangelist-phrasing:
      intent: List time off requests
      effect: read
      questions:
      - Who has time off booked next month?
      - Can I filter time off requests by status or date range?
      instructions:
      - text: List time off requests with status {status}.
        slots:
          status: query.status
      - text: Show time off for employment {employment_id} between {starts_after} and {ends_before}.
        slots:
          employment_id: query.employment_id
          starts_after: query.starts_after
          ends_before: query.ends_before
      method: generated
      generated: '2026-09-26'
- target: $.paths['/timeoff'].post
  update:
    x-apievangelist-phrasing:
      intent: Book time off for an employee
      effect: write
      questions:
      - How do I record vacation for an employee?
      - Can I book time off under a specific leave policy?
      instructions:
      - text: Book {leave_type} for employment {employment_id} from {start_date} to {end_date}.
        slots:
          leave_type: requestBody.leave_type
          employment_id: requestBody.employment_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Request {leave_type} leave for {employment_id}, {start_date} to {end_date}, under policy {leave_policy_id}.
        slots:
          leave_type: requestBody.leave_type
          employment_id: requestBody.employment_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
          leave_policy_id: requestBody.leave_policy_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/timeoff/{timeoff_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a time off request
      effect: read
      questions:
      - What dates and status does a particular time off request have?
      - How do I look up one time off request?
      instructions:
      - text: Show time off request {timeoff_id}.
        slots:
          timeoff_id: path.timeoff_id
      - text: Get the details of leave request {timeoff_id}.
        slots:
          timeoff_id: path.timeoff_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/timeoff/{timeoff_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change the dates of a time off request
      effect: write
      questions:
      - Can I change the dates of time off that's already booked?
      - How do I edit the leave type on an existing request?
      instructions:
      - text: Move time off request {timeoff_id} to {start_date} through {end_date}.
        slots:
          timeoff_id: path.timeoff_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Change the leave type of request {timeoff_id} to {leave_type}.
        slots:
          timeoff_id: path.timeoff_id
          leave_type: requestBody.leave_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/timeoff/{timeoff_id}/approve'].post
  update:
    x-apievangelist-phrasing:
      intent: Approve a time off request
      effect: write
      questions:
      - How do I approve an employee's vacation request?
      - Can managers approve leave through the API?
      instructions:
      - text: Approve time off request {timeoff_id}.
        slots:
          timeoff_id: path.timeoff_id
      - text: Accept the leave request {timeoff_id}.
        slots:
          timeoff_id: path.timeoff_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/timeoff/{timeoff_id}/decline'].post
  update:
    x-apievangelist-phrasing:
      intent: Decline a time off request
      effect: write
      questions:
      - How do I turn down a leave request and give a reason?
      - Is a reason required when declining time off?
      instructions:
      - text: Decline time off request {timeoff_id} because {reason}.
        slots:
          timeoff_id: path.timeoff_id
          reason: requestBody.reason
      - text: Reject leave request {timeoff_id} with the reason {reason}.
        slots:
          timeoff_id: path.timeoff_id
          reason: requestBody.reason
      method: generated
      generated: '2026-09-26'
- target: $.paths['/timeoff/{timeoff_id}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a time off request
      effect: destructive
      questions:
      - How do I cancel time off an employee no longer needs?
      - Can previously booked leave be cancelled?
      instructions:
      - text: Cancel time off request {timeoff_id}.
        slots:
          timeoff_id: path.timeoff_id
      - text: Call off the booked leave {timeoff_id}.
        slots:
          timeoff_id: path.timeoff_id
      method: generated
      generated: '2026-09-26'