Remote · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Remote Employments Contract Documents API

4 actions 4 updates phrasing extends openapi/remote-com-contract-documents-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 4

$.info
$.paths['/contract_documents'].post
$.paths['/contract_documents/{contract_document_id}'].get
$.paths['/contract_documents/{contract_document_id}/sign'].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 Employments Contract Documents API
  version: 1.0.0
extends: openapi/remote-com-contract-documents-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: 3
- target: $.paths['/contract_documents'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a contract document
      effect: write
      questions:
      - How do I generate a new contract document to be signed?
      - Can I create a contract document through the API?
      instructions:
      - text: Create a new contract document.
      - text: Generate a contract document ready for signature.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contract_documents/{contract_document_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a contract document
      effect: read
      questions:
      - Has a contract document been signed yet?
      - How do I retrieve one contract document?
      instructions:
      - text: Show contract document {contract_document_id}.
        slots:
          contract_document_id: path.contract_document_id
      - text: Check the signature status of contract document {contract_document_id}.
        slots:
          contract_document_id: path.contract_document_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contract_documents/{contract_document_id}/sign'].post
  update:
    x-apievangelist-phrasing:
      intent: Sign a contract document
      effect: write
      questions:
      - Can I sign a contract document on behalf of my company through the API?
      - What's the way to sign a contract document electronically?
      instructions:
      - text: Sign contract document {contract_document_id}.
        slots:
          contract_document_id: path.contract_document_id
      - text: Add our signature to contract document {contract_document_id}.
        slots:
          contract_document_id: path.contract_document_id
      method: generated
      generated: '2026-09-26'