Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Invoice Management Invoices API

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

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/invoices/approve'].post
$.paths['/invoices/cancel'].post
$.paths['/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 Invoice Management Invoices API
  version: 1.0.0
extends: openapi/conga-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: 3
- target: $.paths['/invoices/approve'].post
  update:
    x-apievangelist-phrasing:
      intent: Approve invoices
      effect: write
      questions:
      - How do I approve pending invoices?
      - Can I approve several invoices at once?
      instructions:
      - text: Approve invoices {ids}.
        slots:
          ids: requestBody.Ids
      - text: Mark invoices {ids} as approved.
        slots:
          ids: requestBody.Ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/invoices/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel invoices
      effect: destructive
      questions:
      - Can I cancel an invoice that was issued in error?
      - How do I void several invoices at once?
      instructions:
      - text: Cancel invoices {ids}.
        slots:
          ids: requestBody.Ids
      - text: Void the invoices {ids}.
        slots:
          ids: requestBody.Ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/invoices/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get invoice details
      effect: read
      questions:
      - Where can I see the details of one invoice?
      - What line items and totals does an invoice have?
      instructions:
      - text: Get invoice {id}.
        slots:
          id: path.id
      - text: Show the details of invoice {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'