Remote · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Remote Employments Employment Contracts API

3 actions 3 updates phrasing extends openapi/remote-com-employment-contracts-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['/employments/{employment_id}/contracts'].get
$.paths['/employments/{employment_id}/contracts/pending_changes'].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 Employment Contracts API
  version: 1.0.0
extends: openapi/remote-com-employment-contracts-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['/employments/{employment_id}/contracts'].get
  update:
    x-apievangelist-phrasing:
      intent: List an employee's contracts
      effect: read
      questions:
      - What contracts has an employee had with us over time?
      - How do I see every contract version for an employment?
      instructions:
      - text: List the contracts for employment {employment_id}.
        slots:
          employment_id: path.employment_id
      - text: Show the contract history of employment {employment_id}.
        slots:
          employment_id: path.employment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/employments/{employment_id}/contracts/pending_changes'].get
  update:
    x-apievangelist-phrasing:
      intent: See pending contract changes for an employee
      effect: read
      questions:
      - Are there contract changes waiting to take effect for an employee?
      - Which upcoming contract changes haven't been applied yet?
      instructions:
      - text: Show pending contract changes for employment {employment_id}.
        slots:
          employment_id: path.employment_id
      - text: Check what contract updates are queued for employment {employment_id}.
        slots:
          employment_id: path.employment_id
      method: generated
      generated: '2026-09-26'