Remote · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Remote Employments Contract Amendments API

6 actions 6 updates phrasing extends openapi/remote-com-contract-amendments-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 6

$.info
$.paths['/contract_amendments'].get
$.paths['/contract_amendments'].post
$.paths['/contract_amendments/automatable'].post
$.paths['/contract_amendments/{contract_amendment_id}'].get
$.paths['/contract_amendments/schema'].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 Contract Amendments API
  version: 1.0.0
extends: openapi/remote-com-contract-amendments-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: 5
- target: $.paths['/contract_amendments'].get
  update:
    x-apievangelist-phrasing:
      intent: List contract amendments
      effect: read
      questions:
      - Which contract changes have been requested for my employees?
      - Can I filter contract amendments by employee or status?
      instructions:
      - text: List contract amendments for employment {employment_id}.
        slots:
          employment_id: query.employment_id
      - text: Show contract amendments with status {status}.
        slots:
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contract_amendments'].post
  update:
    x-apievangelist-phrasing:
      intent: Request a contract amendment
      effect: write
      questions:
      - How do I request a change to an employee's contract starting on a certain date?
      - Can I submit a contract amendment for manual review by Remote?
      instructions:
      - text: Request a contract amendment for employment {employment_id} effective {effective_date}.
        slots:
          employment_id: requestBody.employment_id
          effective_date: requestBody.effective_date
      - text: Amend the contract of employment {employment_id} from {effective_date} with changes {amendment_data}.
        slots:
          employment_id: requestBody.employment_id
          effective_date: requestBody.effective_date
          amendment_data: requestBody.amendment_data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contract_amendments/automatable'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit an auto-approvable contract amendment
      effect: write
      questions:
      - Can contract changes be approved automatically without Remote reviewing them by hand?
      - What is the structured amendment flow that skips manual review?
      instructions:
      - text: Submit an automatable contract amendment using the structured per-country payload.
      - text: File this salary change as an automatable amendment so it is approved without manual review.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contract_amendments/{contract_amendment_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a contract amendment
      effect: read
      questions:
      - What is the status of a contract amendment I submitted?
      - How do I see the details of one contract amendment?
      instructions:
      - text: Show contract amendment {contract_amendment_id}.
        slots:
          contract_amendment_id: path.contract_amendment_id
      - text: Check the progress of amendment {contract_amendment_id}.
        slots:
          contract_amendment_id: path.contract_amendment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contract_amendments/schema'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the amendment form for an employment
      effect: read
      questions:
      - Which contract fields can be amended for an employee in their country?
      - Where is the JSON Schema for contract amendments per country?
      instructions:
      - text: Fetch the contract amendment schema for employment {employment_id}.
        slots:
          employment_id: query.employment_id
      - text: Show which amendment fields are allowed for employment {employment_id}.
        slots:
          employment_id: query.employment_id
      method: generated
      generated: '2026-09-26'