Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Invoice Management Split Criteria API

7 actions 7 updates phrasing extends openapi/conga-split-criteria-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 7

$.info
$.paths['/split-criteria'].get
$.paths['/split-criteria'].post
$.paths['/split-criteria'].patch
$.paths['/split-criteria/activate'].patch
$.paths['/split-criteria/{id}'].get
$.paths['/split-criteria/{id}/activate'].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 Invoice Management Split Criteria API
  version: 1.0.0
extends: openapi/conga-split-criteria-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: 6
- target: $.paths['/split-criteria'].get
  update:
    x-apievangelist-phrasing:
      intent: List invoice split criteria
      effect: read
      questions:
      - Which invoice split criteria setups are configured?
      - Can I filter the list of split criteria setups?
      instructions:
      - text: List all invoice split criteria setups.
      - text: Show split criteria matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/split-criteria'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an invoice split criteria setup
      effect: write
      questions:
      - How do I set up new criteria for splitting invoices?
      - Can I add a split criteria setup to invoice management?
      instructions:
      - text: Create a new invoice split criteria setup.
      - text: Add a split criteria setup for invoices.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/split-criteria'].patch
  update:
    x-apievangelist-phrasing:
      intent: Bulk-update invoice split criteria
      effect: write
      questions:
      - Can I update several split criteria setups in one request?
      - What happens if only some split criteria updates succeed?
      instructions:
      - text: Bulk-update these split criteria setups.
      - text: Apply my edits to several invoice split criteria at once.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/split-criteria/activate'].patch
  update:
    x-apievangelist-phrasing:
      intent: Toggle active status on several split criteria
      effect: write
      questions:
      - How do I activate or deactivate multiple split criteria setups together?
      - Can I flip the active flag on a batch of split criteria?
      instructions:
      - text: Toggle the active status of these split criteria setups.
      - text: Switch several invoice split criteria between active and inactive.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/split-criteria/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a split criteria setup
      effect: read
      questions:
      - How do I look up one invoice split criteria setup?
      - What does a specific split criteria setup define?
      instructions:
      - text: Get split criteria setup {id}.
        slots:
          id: path.id
      - text: Show the invoice split criteria with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/split-criteria/{id}/activate'].patch
  update:
    x-apievangelist-phrasing:
      intent: Activate one split criteria setup
      effect: write
      questions:
      - Can I activate or deactivate a single split criteria setup by ID?
      - How do I turn on one specific invoice split rule?
      instructions:
      - text: Activate split criteria setup {id}.
        slots:
          id: path.id
      - text: Set split criteria {id} active to {active}.
        slots:
          id: path.id
          active: query.active
      method: generated
      generated: '2026-10-01'