Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Invoice Management Invoice Request Results API

3 actions 3 updates phrasing extends openapi/conga-invoice-request-results-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 3

$.info
$.paths['/request-results/{id}'].get
$.paths['/request-results/{id}/invoices'].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 Invoice Request Results API
  version: 1.0.0
extends: openapi/conga-invoice-request-results-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['/request-results/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an invoice request result
      effect: read
      questions:
      - Where can I see one invoice request result?
      - Can I include related records in an invoice request result?
      instructions:
      - text: Get invoice request result {id}.
        slots:
          id: path.id
      - text: Show request result {id} including {includes}.
        slots:
          id: path.id
          includes: query.includes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/request-results/{id}/invoices'].get
  update:
    x-apievangelist-phrasing:
      intent: List invoices from a request result
      effect: read
      questions:
      - Which invoices were created by an invoice run result?
      - Can I list every invoice behind one request result?
      instructions:
      - text: List invoices from request result {id}.
        slots:
          id: path.id
      - text: Show the invoices generated by result {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'