Remote · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Remote Employments Offboarding API

3 actions 3 updates phrasing extends openapi/remote-com-offboarding-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['/offboardings'].post
$.paths['/offboardings/{offboarding_id}'].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 Remote Employments Offboarding API
  version: 1.0.0
extends: openapi/remote-com-offboarding-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['/offboardings'].post
  update:
    x-apievangelist-phrasing:
      intent: Start offboarding an employee
      effect: write
      questions:
      - How do I begin offboarding an employee who is leaving?
      - What details are needed to submit a resignation or termination?
      instructions:
      - text: Offboard employment {employment_id} as a {offboarding_type} with last day {last_day_of_work}.
        slots:
          employment_id: requestBody.employment_id
          offboarding_type: requestBody.offboarding_type
          last_day_of_work: requestBody.last_day_of_work
      - text: Submit a {offboarding_type} offboarding for {employment_id}, last day {last_day_of_work}, reason {reason_for_offboarding}.
        slots:
          offboarding_type: requestBody.offboarding_type
          employment_id: requestBody.employment_id
          last_day_of_work: requestBody.last_day_of_work
          reason_for_offboarding: requestBody.reason_for_offboarding
      method: generated
      generated: '2026-09-26'
- target: $.paths['/offboardings/{offboarding_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an offboarding's progress
      effect: read
      questions:
      - Where does an employee's offboarding stand?
      - How do I look up an offboarding I submitted?
      instructions:
      - text: Show offboarding {offboarding_id}.
        slots:
          offboarding_id: path.offboarding_id
      - text: Check the status of offboarding {offboarding_id}.
        slots:
          offboarding_id: path.offboarding_id
      method: generated
      generated: '2026-09-26'