Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Administration Waterfall Charts API

8 actions 8 updates phrasing extends openapi/conga-waterfall-charts-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['/waterfalls/{ParentId}/charts'].get
$.paths['/waterfalls/{ParentId}/charts'].post
$.paths['/waterfalls/{ParentId}/charts'].delete
$.paths['/waterfalls/{ParentId}/charts'].patch
$.paths['/waterfalls/{ParentId}/charts/{Id}'].get
$.paths['/waterfalls/{ParentId}/charts/{Id}'].delete
$.paths['/waterfalls/{ParentId}/charts/{Id}'].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 Administration Waterfall Charts API
  version: 1.0.0
extends: openapi/conga-waterfall-charts-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['/waterfalls/{ParentId}/charts'].get
  update:
    x-apievangelist-phrasing:
      intent: List the charts in a price waterfall
      effect: read
      questions:
      - Which charts are attached to a given price waterfall in Conga CPQ?
      - Can I filter and page through a waterfall's charts?
      instructions:
      - text: List the charts in waterfall {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Show waterfall {ParentId} charts matching {filter}, {limit} per page.
        slots:
          ParentId: path.ParentId
          filter: query.filter
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/waterfalls/{ParentId}/charts'].post
  update:
    x-apievangelist-phrasing:
      intent: Add charts to a waterfall
      effect: write
      questions:
      - How do I add a new chart to a price waterfall?
      - Can I create several waterfall charts for one waterfall at once?
      instructions:
      - text: Create these charts under waterfall {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Add new chart definitions to waterfall {ParentId}.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/waterfalls/{ParentId}/charts'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several charts from a waterfall
      effect: destructive
      questions:
      - Can I remove multiple charts from a waterfall in one request?
      - Does bulk chart deletion report a status for each chart ID?
      instructions:
      - text: Bulk-delete these charts from waterfall {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Remove the listed charts from waterfall {ParentId} and report each status.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/waterfalls/{ParentId}/charts'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update several charts in a waterfall
      effect: write
      questions:
      - Can I edit fields on many of a waterfall's charts together?
      - Is the parent waterfall ID editable when bulk-updating its charts?
      instructions:
      - text: Bulk-update these charts in waterfall {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Apply field changes to multiple charts under waterfall {ParentId}.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/waterfalls/{ParentId}/charts/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one waterfall chart
      effect: read
      questions:
      - What are the details of a single chart in a price waterfall?
      - Can I look up one waterfall chart by its ID?
      instructions:
      - text: Show chart {Id} in waterfall {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Get the single waterfall chart {Id} from waterfall {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/waterfalls/{ParentId}/charts/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one waterfall chart
      effect: destructive
      questions:
      - Is there a way to delete just one chart from a waterfall?
      - What happens to the waterfall when I delete one of its charts?
      instructions:
      - text: Delete chart {Id} from waterfall {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Remove the single chart {Id} under waterfall {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/waterfalls/{ParentId}/charts/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update one waterfall chart
      effect: write
      questions:
      - Can I change the settings of one chart in a price waterfall?
      - Which call edits a single waterfall chart document?
      instructions:
      - text: Update chart {Id} in waterfall {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Edit just waterfall chart {Id} belonging to {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'