Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Administration Waterfalls API

8 actions 8 updates phrasing extends openapi/conga-waterfalls-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'].get

$.paths['/waterfalls'].post

$.paths['/waterfalls'].delete

$.paths['/waterfalls'].patch

$.paths['/waterfalls/{Id}'].get

$.paths['/waterfalls/{Id}'].delete

$.paths['/waterfalls/{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 Waterfalls API
  version: 1.0.0
extends: openapi/conga-waterfalls-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'].get
  update:
    x-apievangelist-phrasing:
      intent: List price waterfalls
      effect: read
      questions:
      - Which price waterfalls exist in my Conga CPQ setup?
      - Can I filter and sort the list of waterfalls?
      instructions:
      - text: List all price waterfalls matching {filter}.
        slots:
          filter: query.filter
      - text: Show waterfalls sorted by {sort}, page {page} of {limit}.
        slots:
          sort: query.sort
          page: query.page
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/waterfalls'].post
  update:
    x-apievangelist-phrasing:
      intent: Create price waterfalls
      effect: write
      questions:
      - How do I set up new price waterfalls?
      - Can I create several waterfalls in one request?
      instructions:
      - text: Create these new price waterfalls.
      - text: Add a batch of waterfalls from this payload.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/waterfalls'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several price waterfalls at once
      effect: destructive
      questions:
      - Can I remove multiple price waterfalls in one call?
      - Is there a bulk delete for waterfalls?
      instructions:
      - text: Bulk-delete the price waterfalls in this list.
      - text: Remove all of these waterfalls together.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/waterfalls'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update several price waterfalls at once
      effect: write
      questions:
      - Can I edit many price waterfalls with a single update?
      - Which call changes multiple waterfalls together?
      instructions:
      - text: Bulk-update these price waterfalls.
      - text: Apply the listed changes across multiple waterfalls.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/waterfalls/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one price waterfall
      effect: read
      questions:
      - What's configured on a single price waterfall?
      - Can I fetch one waterfall with its related records included?
      instructions:
      - text: Show price waterfall {Id}.
        slots:
          Id: path.Id
      - text: Get waterfall {Id} including {includes}.
        slots:
          Id: path.Id
          includes: query.includes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/waterfalls/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one price waterfall
      effect: destructive
      questions:
      - How do I delete a single waterfall by its ID?
      - If I delete one waterfall, do the others stay as they are?
      instructions:
      - text: Delete price waterfall {Id}.
        slots:
          Id: path.Id
      - text: Remove only the waterfall {Id}.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/waterfalls/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update one price waterfall
      effect: write
      questions:
      - Can I edit just one price waterfall?
      - Is there a call to modify the settings of a single waterfall?
      instructions:
      - text: Update price waterfall {Id} with these changes.
        slots:
          Id: path.Id
      - text: Edit the single waterfall {Id}.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-10-01'