Remote · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Remote Employments Work Authorization API

4 actions 4 updates phrasing extends openapi/remote-com-work-authorization-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['/work_authorization_requests'].get

$.paths['/work_authorization_requests/{work_authorization_request_id}'].get

$.paths['/work_authorization_requests/{work_authorization_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 Work Authorization API
  version: 1.0.0
extends: openapi/remote-com-work-authorization-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['/work_authorization_requests'].get
  update:
    x-apievangelist-phrasing:
      intent: List work authorization requests
      effect: read
      questions:
      - Which employees have requested work authorization or visa support?
      - What work authorization requests are pending?
      instructions:
      - text: List all work authorization requests.
      - text: Show open work permit requests.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/work_authorization_requests/{work_authorization_request_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a work authorization request
      effect: read
      questions:
      - What is the status of an employee's work permit request?
      - How do I look up one work authorization request?
      instructions:
      - text: Show work authorization request {work_authorization_request_id}.
        slots:
          work_authorization_request_id: path.work_authorization_request_id
      - text: Check work permit request {work_authorization_request_id}.
        slots:
          work_authorization_request_id: path.work_authorization_request_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/work_authorization_requests/{work_authorization_request_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a work authorization request
      effect: write
      questions:
      - Can I change or respond to a work authorization request?
      - How do I update a pending visa support request?
      instructions:
      - text: Update work authorization request {work_authorization_request_id}.
        slots:
          work_authorization_request_id: path.work_authorization_request_id
      - text: Edit work permit request {work_authorization_request_id}.
        slots:
          work_authorization_request_id: path.work_authorization_request_id
      method: generated
      generated: '2026-09-26'