Remote · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Remote Companies Company Managers API

5 actions 5 updates phrasing extends openapi/remote-com-company-managers-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['/companies/{company_id}/managers'].get

$.paths['/companies/{company_id}/managers'].post

$.paths['/companies/{company_id}/managers/{manager_id}'].get

$.paths['/companies/{company_id}/managers/{manager_id}'].delete

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 Company Managers API
  version: 1.0.0
extends: openapi/remote-com-company-managers-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['/companies/{company_id}/managers'].get
  update:
    x-apievangelist-phrasing:
      intent: List a company's managers
      effect: read
      questions:
      - Who has manager or admin access to my company on Remote?
      - Can I see every manager set up for a company?
      instructions:
      - text: List the managers of company {company_id}.
        slots:
          company_id: path.company_id
      - text: Show everyone with manager access at company {company_id}.
        slots:
          company_id: path.company_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/companies/{company_id}/managers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a manager to a company
      effect: write
      questions:
      - How do I give a colleague admin access to our Remote account?
      - Can I add a manager to a company with a specific role?
      instructions:
      - text: Add {email} as a {role} manager at company {company_id}.
        slots:
          email: requestBody.email
          role: requestBody.role
          company_id: path.company_id
      - text: Invite {name} ({email}) to company {company_id} with role {role}.
        slots:
          name: requestBody.name
          email: requestBody.email
          company_id: path.company_id
          role: requestBody.role
      method: generated
      generated: '2026-09-26'
- target: $.paths['/companies/{company_id}/managers/{manager_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View one company manager
      effect: read
      questions:
      - What role does a particular manager have at my company?
      - How do I look up a single company manager's details?
      instructions:
      - text: Show manager {manager_id} at company {company_id}.
        slots:
          manager_id: path.manager_id
          company_id: path.company_id
      - text: Get the role and details of manager {manager_id} in company {company_id}.
        slots:
          manager_id: path.manager_id
          company_id: path.company_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/companies/{company_id}/managers/{manager_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a manager from a company
      effect: destructive
      questions:
      - How do I revoke a manager's access to our company?
      - Can I remove someone who left the team from our company managers?
      instructions:
      - text: Remove manager {manager_id} from company {company_id}.
        slots:
          manager_id: path.manager_id
          company_id: path.company_id
      - text: Delete the manager account {manager_id} at company {company_id}.
        slots:
          manager_id: path.manager_id
          company_id: path.company_id
      method: generated
      generated: '2026-09-26'