Remote · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Remote Companies Magic Links API

2 actions 2 updates phrasing extends openapi/remote-com-magic-links-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 2

$.info

$.paths['/magic_links'].post

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 Companies Magic Links API
  version: 1.0.0
extends: openapi/remote-com-magic-links-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: 1
- target: $.paths['/magic_links'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a passwordless login link
      effect: write
      questions:
      - How can I log a user or employee into Remote without a password?
      - Can I make a single-use login link that expires after a few minutes?
      instructions:
      - text: Generate a magic link for user {user_id}.
        slots:
          user_id: requestBody.user_id
      - text: Create a login link for employment {employment_id} that expires in {timeout_in_minutes} minutes and opens {target_section}.
        slots:
          employment_id: requestBody.employment_id
          timeout_in_minutes: requestBody.timeout_in_minutes
          target_section: requestBody.target_section
      method: generated
      generated: '2026-09-26'