Remote · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Remote Employments Travel Letters API

5 actions 5 updates phrasing extends openapi/remote-com-travel-letters-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 5

$.info

$.paths['/travel_letter_requests'].get

$.paths['/travel_letter_requests'].post

$.paths['/travel_letter_requests/{travel_letter_request_id}'].get

$.paths['/travel_letter_requests/{travel_letter_request_id}'].patch

OpenAPI Overlay

# 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 Travel Letters API
  version: 1.0.0
extends: openapi/remote-com-travel-letters-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: 4
- target: $.paths['/travel_letter_requests'].get
  update:
    x-apievangelist-phrasing:
      intent: List travel letter requests
      effect: read
      questions:
      - Which employees have asked for a travel letter?
      - What travel letter requests are open?
      instructions:
      - text: List all travel letter requests.
      - text: Show pending travel letter requests.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/travel_letter_requests'].post
  update:
    x-apievangelist-phrasing:
      intent: Request a travel letter
      effect: write
      questions:
      - How do I request an employment travel letter for a trip abroad?
      - Can I create a travel letter request through the API?
      instructions:
      - text: Create a travel letter request.
      - text: Request a new employment travel letter.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/travel_letter_requests/{travel_letter_request_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a travel letter request
      effect: read
      questions:
      - What is the status of a travel letter I requested?
      - How do I look up one travel letter request?
      instructions:
      - text: Show travel letter request {travel_letter_request_id}.
        slots:
          travel_letter_request_id: path.travel_letter_request_id
      - text: Check on travel letter {travel_letter_request_id}.
        slots:
          travel_letter_request_id: path.travel_letter_request_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/travel_letter_requests/{travel_letter_request_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a travel letter request
      effect: write
      questions:
      - Can I change the details of a travel letter request already submitted?
      - How do I approve or edit an existing travel letter request?
      instructions:
      - text: Update travel letter request {travel_letter_request_id}.
        slots:
          travel_letter_request_id: path.travel_letter_request_id
      - text: Edit the details of travel letter {travel_letter_request_id}.
        slots:
          travel_letter_request_id: path.travel_letter_request_id
      method: generated
      generated: '2026-09-26'