Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Administration Waterfall Rule Entry API

8 actions 8 updates phrasing extends openapi/conga-waterfallruleentry-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 8

$.info

$.paths['/waterfall-rules/{ParentId}/entries'].get

$.paths['/waterfall-rules/{ParentId}/entries'].post

$.paths['/waterfall-rules/{ParentId}/entries'].delete

$.paths['/waterfall-rules/{ParentId}/entries'].patch

$.paths['/waterfall-rules/{ParentId}/entries/{Id}'].get

$.paths['/waterfall-rules/{ParentId}/entries/{Id}'].delete

$.paths['/waterfall-rules/{ParentId}/entries/{Id}'].patch

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Administration Waterfall Rule Entry API
  version: 1.0.0
extends: openapi/conga-waterfallruleentry-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: 7
- target: $.paths['/waterfall-rules/{ParentId}/entries'].get
  update:
    x-apievangelist-phrasing:
      intent: List the entries in a waterfall rule
      effect: read
      questions:
      - Which entries make up a given waterfall rule in Conga CPQ?
      - Can I page through a waterfall rule's entries with a filter?
      instructions:
      - text: List the entries in waterfall rule {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Show waterfall rule {ParentId} entries matching {filter}, page {page}.
        slots:
          ParentId: path.ParentId
          filter: query.filter
          page: query.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/waterfall-rules/{ParentId}/entries'].post
  update:
    x-apievangelist-phrasing:
      intent: Add entries to a waterfall rule
      effect: write
      questions:
      - How many entries can I create on one waterfall rule?
      - How do I add condition or dimension entries to a waterfall rule?
      instructions:
      - text: Create these entries on waterfall rule {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Add up to 100 new rule entries to waterfall rule {ParentId}.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/waterfall-rules/{ParentId}/entries'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several entries from a waterfall rule
      effect: destructive
      questions:
      - Can I remove many entries from a condition or dimension waterfall rule at once?
      - Does the bulk entry delete return a status per entry?
      instructions:
      - text: Bulk-delete these entries from waterfall rule {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Remove the listed rule entries under waterfall rule {ParentId}.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/waterfall-rules/{ParentId}/entries'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update several entries in a waterfall rule
      effect: write
      questions:
      - Can I edit fields on many waterfall rule entries together?
      - Is the entry ID changeable when I bulk-update rule entries?
      instructions:
      - text: Bulk-update these entries on waterfall rule {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Apply field changes to multiple entries of waterfall rule {ParentId}.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/waterfall-rules/{ParentId}/entries/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one waterfall rule entry
      effect: read
      questions:
      - What are the details of a single entry in a waterfall rule?
      - Can I look up one rule entry by its ID?
      instructions:
      - text: Show entry {Id} in waterfall rule {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Get the single rule entry {Id} from waterfall rule {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/waterfall-rules/{ParentId}/entries/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one waterfall rule entry
      effect: destructive
      questions:
      - Is there a way to delete just one entry from a waterfall rule?
      - Will removing a single rule entry affect the other entries?
      instructions:
      - text: Delete entry {Id} from waterfall rule {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Remove only rule entry {Id} in waterfall rule {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/waterfall-rules/{ParentId}/entries/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update one waterfall rule entry
      effect: write
      questions:
      - Can I change a single entry on a waterfall rule?
      - Which call edits one waterfall rule entry document?
      instructions:
      - text: Update entry {Id} in waterfall rule {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Edit just rule entry {Id} under waterfall rule {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'