# 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 Rules API
  version: 1.0.0
extends: openapi/conga-waterfall-rules-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/{ParentId}/rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List the rules in a waterfall rule set
      effect: read
      questions:
      - Which waterfall rules belong to a given rule set in Conga CPQ?
      - Can I sort and filter the rules inside a waterfall rule set?
      instructions:
      - text: List the waterfall rules in rule set {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Show rules in rule set {ParentId} matching {filterExpression}, sorted by {sort}.
        slots:
          ParentId: path.ParentId
          filterExpression: query.filterExpression
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/waterfall-rule-sets/{ParentId}/rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Add rules to a waterfall rule set
      effect: write
      questions:
      - How do I add new rules to a waterfall rule set?
      - Can I create several waterfall rules in a rule set at once?
      instructions:
      - text: Create these waterfall rules in rule set {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Add new rules to waterfall rule set {ParentId}.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/waterfall-rule-sets/{ParentId}/rules'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several rules from a waterfall rule set
      effect: destructive
      questions:
      - What's the maximum number of waterfall rules I can delete in one request?
      - Are a rule's entries removed too when I bulk-delete waterfall rules?
      instructions:
      - text: Bulk-delete these rules from rule set {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Remove up to 100 listed waterfall rules from rule set {ParentId}.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/waterfall-rule-sets/{ParentId}/rules'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update several rules in a waterfall rule set
      effect: write
      questions:
      - Can I change fields on many waterfall rules in a rule set together?
      - Can I edit the waterfall rule ID during a bulk rule update?
      instructions:
      - text: Bulk-update these rules in rule set {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Apply field changes to multiple waterfall rules under rule set {ParentId}.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/waterfall-rule-sets/{ParentId}/rules/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one waterfall rule
      effect: read
      questions:
      - What does a single waterfall rule in a rule set look like?
      - Can I fetch one waterfall rule by its ID?
      instructions:
      - text: Show waterfall rule {Id} in rule set {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Get the single rule {Id} from waterfall rule set {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/waterfall-rule-sets/{ParentId}/rules/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one waterfall rule
      effect: destructive
      questions:
      - Is there a way to delete just one rule from a waterfall rule set?
      - Will deleting a single waterfall rule leave the rest of the rule set intact?
      instructions:
      - text: Delete waterfall rule {Id} from rule set {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Remove only rule {Id} in waterfall rule set {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/waterfall-rule-sets/{ParentId}/rules/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update one waterfall rule
      effect: write
      questions:
      - Can I edit one waterfall rule without touching the others in its set?
      - Which call changes a single waterfall rule document?
      instructions:
      - text: Update waterfall rule {Id} in rule set {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Edit just rule {Id} under waterfall rule set {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'