Remote · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Remote Companies Departments API

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

$.info
$.paths['/companies/{company_id}/departments'].get
$.paths['/companies/{company_id}/departments'].post

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 Companies Departments API
  version: 1.0.0
extends: openapi/remote-com-departments-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: 2
- target: $.paths['/companies/{company_id}/departments'].get
  update:
    x-apievangelist-phrasing:
      intent: List a company's departments
      effect: read
      questions:
      - What departments exist in my company on Remote?
      - Can I see a company's department list?
      instructions:
      - text: List the departments of company {company_id}.
        slots:
          company_id: path.company_id
      - text: Show all departments set up for company {company_id}.
        slots:
          company_id: path.company_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/companies/{company_id}/departments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a department
      effect: write
      questions:
      - How do I add a new department to my company?
      - Can I nest a department under a parent department?
      instructions:
      - text: Create a department named {name} in company {company_id}.
        slots:
          name: requestBody.name
          company_id: path.company_id
      - text: Add department {name} under parent {parent_department_id} at company {company_id}.
        slots:
          name: requestBody.name
          parent_department_id: requestBody.parent_department_id
          company_id: path.company_id
      method: generated
      generated: '2026-09-26'