DoiT · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DoiT Invoices API

3 actions 3 updates phrasing extends openapi/doit-invoices-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for DoiT's API. It is a proposal applied on top of the contract, not a document DoiT publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/billing/v1/invoices'].get
$.paths['/billing/v1/invoices/{id}'].get

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 DoiT Invoices API
  version: 1.0.0
extends: openapi/doit-invoices-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/billing/v1/invoices'].get
  update:
    x-apievangelist-phrasing:
      intent: List invoices
      effect: read
      questions:
      - Where can I see all of our DoiT invoices?
      - Can I list invoices issued in a specific date range?
      instructions:
      - text: List invoices created after {since}.
        slots:
          since: query.minCreationTime
      - text: Show all current and historical invoices.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/billing/v1/invoices/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve an invoice
      effect: read
      questions:
      - How do I get the full details of one invoice?
      - Can I look up an invoice by its invoice number?
      instructions:
      - text: Get invoice {id}.
        slots:
          id: path.id
      - text: Show me the line details of invoice number {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'