Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cart - V1 Price Waterfall API

6 actions 6 updates phrasing extends openapi/conga-pricewaterfall-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 6

$.info

$.paths['/api/cart/v1/carts/{cartId}/items/{lineitemId}/waterfallchart'].get

$.paths['/api/cart/v1/carts/{cartId}/items/{lineitemId}/waterfallchart/{chartId}'].get

$.paths['/api/cart/v1/carts/{cartId}/summarygroups/{summarygroupId}/waterfallchart'].get

$.paths['/api/cart/v1/carts/{cartId}/summarygroups/{summarygroupId}/waterfallchart/{chartId}'].get

$.paths['/api/cart/v1/carts/{cartId}/waterfallchart'].get

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 Cart - V1 Price Waterfall API
  version: 1.0.0
extends: openapi/conga-pricewaterfall-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: 5
- target: $.paths['/api/cart/v1/carts/{cartId}/items/{lineitemId}/waterfallchart'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the price waterfall for a cart line item
      effect: read
      questions:
      - How do I see the price waterfall breakdown for one line item in a cart?
      - What adjustments took a cart line item from list price to its net price?
      instructions:
      - text: Show the price waterfall for line item {lineitemId} in cart {cartId}.
        slots:
          lineitemId: path.lineitemId
          cartId: path.cartId
      - text: Get the full waterfall chart detail of cart {cartId} line {lineitemId}.
        slots:
          cartId: path.cartId
          lineitemId: path.lineitemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/items/{lineitemId}/waterfallchart/{chartId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one waterfall chart for a cart line item
      effect: read
      questions:
      - Can I pull a specific waterfall chart for a cart line item by chart ID?
      - When a line item has several waterfall charts, how do I fetch just one of them?
      instructions:
      - text: Get waterfall chart {chartId} for line item {lineitemId} in cart {cartId}.
        slots:
          chartId: path.chartId
          lineitemId: path.lineitemId
          cartId: path.cartId
      - text: Show only chart {chartId} of the price waterfall on cart {cartId} line {lineitemId}.
        slots:
          chartId: path.chartId
          cartId: path.cartId
          lineitemId: path.lineitemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/summarygroups/{summarygroupId}/waterfallchart'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the price waterfall for a cart summary group
      effect: read
      questions:
      - How do I see a price waterfall rolled up for a summary group in a cart?
      - Can I view waterfall details at the summary group level instead of per line?
      instructions:
      - text: Show the price waterfall for summary group {summarygroupId} in cart {cartId}.
        slots:
          summarygroupId: path.summarygroupId
          cartId: path.cartId
      - text: Get the summary group waterfall detail of cart {cartId} group {summarygroupId}.
        slots:
          cartId: path.cartId
          summarygroupId: path.summarygroupId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/summarygroups/{summarygroupId}/waterfallchart/{chartId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one waterfall chart for a cart summary group
      effect: read
      questions:
      - Can I fetch one specific waterfall chart for a cart summary group by its chart ID?
      - Which call returns a single summary group waterfall chart rather than all of them?
      instructions:
      - text: Get waterfall chart {chartId} for summary group {summarygroupId} in cart {cartId}.
        slots:
          chartId: path.chartId
          summarygroupId: path.summarygroupId
          cartId: path.cartId
      - text: Show only chart {chartId} of summary group {summarygroupId} on cart {cartId}.
        slots:
          chartId: path.chartId
          summarygroupId: path.summarygroupId
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/waterfallchart'].get
  update:
    x-apievangelist-phrasing:
      intent: Get price waterfalls for all lines in a cart
      effect: read
      questions:
      - How do I get the price waterfall for every line item in a cart at once?
      - Can I page through cart-wide waterfall details for a large Conga cart?
      - Is it possible to limit a batch waterfall request to certain primary line numbers?
      instructions:
      - text: Get price waterfalls for all line items in cart {cartId}.
        slots:
          cartId: path.cartId
      - text: Show batch waterfall details for primary lines {primaryLineNumbers} in cart {cartId}.
        slots:
          primaryLineNumbers: query.primaryLineNumbers
          cartId: path.cartId
      - text: Get page {pageNumber} of cart {cartId} waterfalls, {pageSize} lines per page.
        slots:
          pageNumber: query.pageNumber
          cartId: path.cartId
          pageSize: query.pageSize
      - text: Return only waterfall charts {chartIds} across all lines of cart {cartId}.
        slots:
          chartIds: query.chartIds
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'