Remote · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Remote Contractors Scheduled Invoices API

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

$.info
$.paths['/scheduled_contractor_invoices'].get
$.paths['/scheduled_contractor_invoices/bulk'].post
$.paths['/scheduled_contractor_invoices/{scheduled_invoice_id}'].get
$.paths['/scheduled_contractor_invoices/{scheduled_invoice_id}'].patch

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 Contractors Scheduled Invoices API
  version: 1.0.0
extends: openapi/remote-com-scheduled-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: 4
- target: $.paths['/scheduled_contractor_invoices'].get
  update:
    x-apievangelist-phrasing:
      intent: List scheduled contractor invoices
      effect: read
      questions:
      - Which recurring contractor invoices are scheduled?
      - What automated contractor payments have I set up?
      instructions:
      - text: List all scheduled contractor invoices.
      - text: Show my recurring contractor invoice schedules.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scheduled_contractor_invoices/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule contractor invoices in bulk
      effect: write
      questions:
      - How do I set up recurring invoices for many contractors at once?
      - Can I create several scheduled contractor invoices in one request?
      instructions:
      - text: 'Create these scheduled contractor invoices in bulk: {scheduled_contractor_invoices}.'
        slots:
          scheduled_contractor_invoices: requestBody.scheduled_contractor_invoices
      - text: Schedule recurring invoices for all my contractors in one batch.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scheduled_contractor_invoices/{scheduled_invoice_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a scheduled contractor invoice
      effect: read
      questions:
      - What amount and recurrence is set on a scheduled contractor invoice?
      - How do I look up one invoice schedule?
      instructions:
      - text: Show scheduled contractor invoice {scheduled_invoice_id}.
        slots:
          scheduled_invoice_id: path.scheduled_invoice_id
      - text: Get the schedule details of invoice {scheduled_invoice_id}.
        slots:
          scheduled_invoice_id: path.scheduled_invoice_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scheduled_contractor_invoices/{scheduled_invoice_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a scheduled contractor invoice
      effect: write
      questions:
      - Can I change the amount or end date of a recurring contractor invoice?
      - How do I edit a contractor's invoice schedule?
      instructions:
      - text: Update scheduled invoice {scheduled_invoice_id} to {amount} {currency} every {recurrence}.
        slots:
          scheduled_invoice_id: path.scheduled_invoice_id
          amount: requestBody.amount
          currency: requestBody.currency
          recurrence: requestBody.recurrence
      - text: End scheduled invoice {scheduled_invoice_id} on {ends_on}.
        slots:
          scheduled_invoice_id: path.scheduled_invoice_id
          ends_on: requestBody.ends_on
      method: generated
      generated: '2026-09-26'