Remote · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Remote Contractors COR Termination API

4 actions 4 updates phrasing extends openapi/remote-com-cor-termination-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 4

$.info
$.paths['/contractors/{employment_id}/cor_termination'].get
$.paths['/contractors/{employment_id}/cor_termination'].post
$.paths['/contractors/{employment_id}/terminate'].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 Contractors COR Termination API
  version: 1.0.0
extends: openapi/remote-com-cor-termination-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: 3
- target: $.paths['/contractors/{employment_id}/cor_termination'].get
  update:
    x-apievangelist-phrasing:
      intent: View a COR termination request
      effect: read
      questions:
      - What is the status of the request to end a Contractor of Record engagement?
      - Has a termination request already been filed for this COR contractor?
      instructions:
      - text: Show the COR termination request for contractor {employment_id}.
        slots:
          employment_id: path.employment_id
      - text: Check the end-of-engagement request of contractor {employment_id}.
        slots:
          employment_id: path.employment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contractors/{employment_id}/cor_termination'].post
  update:
    x-apievangelist-phrasing:
      intent: Request to end a COR engagement
      effect: write
      questions:
      - How do I ask Remote to end a Contractor of Record engagement on a specific last day?
      - What reason and date are needed to request a COR termination?
      instructions:
      - text: Request termination of COR contractor {employment_id} with last day {last_day_of_engagement} because {reason}.
        slots:
          employment_id: path.employment_id
          last_day_of_engagement: requestBody.last_day_of_engagement
          reason: requestBody.reason
      - text: File a COR end-of-engagement request for {employment_id} on {last_day_of_engagement}, reason {reason}, notes {additional_information}.
        slots:
          employment_id: path.employment_id
          last_day_of_engagement: requestBody.last_day_of_engagement
          reason: requestBody.reason
          additional_information: requestBody.additional_information
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contractors/{employment_id}/terminate'].post
  update:
    x-apievangelist-phrasing:
      intent: Terminate a Contractor of Record employment
      effect: destructive
      questions:
      - How do I immediately terminate a Contractor of Record employment?
      - Can I finalize ending a COR contractor's employment through the API?
      instructions:
      - text: Terminate the Contractor of Record employment {employment_id}.
        slots:
          employment_id: path.employment_id
      - text: End COR employment {employment_id} now.
        slots:
          employment_id: path.employment_id
      method: generated
      generated: '2026-09-26'