Remote · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Remote Contractors Contractor Invoices API

3 actions 3 updates phrasing extends openapi/remote-com-contractor-invoices-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['/contractor_invoices'].get

$.paths['/contractor_invoices/{contractor_invoice_id}'].get

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 Contractors Contractor Invoices API
  version: 1.0.0
extends: openapi/remote-com-contractor-invoices-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['/contractor_invoices'].get
  update:
    x-apievangelist-phrasing:
      intent: List contractor invoices
      effect: read
      questions:
      - Which invoices have my contractors submitted?
      - Can I filter contractor invoices by contractor or status?
      instructions:
      - text: List contractor invoices for employment {employment_id}.
        slots:
          employment_id: query.employment_id
      - text: Show contractor invoices with status {status}.
        slots:
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contractor_invoices/{contractor_invoice_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a contractor invoice
      effect: read
      questions:
      - How do I see the amount and status of one contractor invoice?
      - Where can I look up a single invoice a contractor sent?
      instructions:
      - text: Show contractor invoice {contractor_invoice_id}.
        slots:
          contractor_invoice_id: path.contractor_invoice_id
      - text: Get the details of contractor invoice {contractor_invoice_id}.
        slots:
          contractor_invoice_id: path.contractor_invoice_id
      method: generated
      generated: '2026-09-26'