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