# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Administration Incentive Rules API
  version: 1.0.0
extends: openapi/conga-incentive-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['/incentives/{ParentId}/rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List an incentive's rules
      effect: read
      questions:
      - Which rules are attached to an incentive?
      - Can I filter the rules on an incentive?
      instructions:
      - text: List rules of incentive {incentive}.
        slots:
          incentive: path.ParentId
      - text: Show rules on incentive {incentive} matching {filter}.
        slots:
          incentive: path.ParentId
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/incentives/{ParentId}/rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create incentive rules
      effect: write
      questions:
      - How do I add rules to an incentive?
      - Can I create several incentive rules at once?
      instructions:
      - text: Create rules on incentive {incentive}.
        slots:
          incentive: path.ParentId
      - text: Add new rules to incentive {incentive}.
        slots:
          incentive: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/incentives/{ParentId}/rules'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete incentive rules in bulk
      effect: destructive
      questions:
      - Can I remove many rules from an incentive?
      - How do I bulk-delete incentive rules?
      instructions:
      - text: Bulk delete rules on incentive {incentive}.
        slots:
          incentive: path.ParentId
      - text: Remove the selected rules from incentive {incentive}.
        slots:
          incentive: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/incentives/{ParentId}/rules'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update incentive rules in bulk
      effect: write
      questions:
      - Can I edit several incentive rules in one call?
      - How do I bulk-update rules on an incentive?
      instructions:
      - text: Bulk update rules on incentive {incentive}.
        slots:
          incentive: path.ParentId
      - text: Edit the selected rules of incentive {incentive}.
        slots:
          incentive: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/incentives/{ParentId}/rules/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an incentive rule
      effect: read
      questions:
      - Where can I see one incentive rule?
      - What does a single incentive rule specify?
      instructions:
      - text: Get rule {id} of incentive {incentive}.
        slots:
          id: path.Id
          incentive: path.ParentId
      - text: Show incentive rule {id} on {incentive}.
        slots:
          id: path.Id
          incentive: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/incentives/{ParentId}/rules/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an incentive rule
      effect: destructive
      questions:
      - Can I delete a single incentive rule?
      - How do I remove one rule from an incentive?
      instructions:
      - text: Delete rule {id} from incentive {incentive}.
        slots:
          id: path.Id
          incentive: path.ParentId
      - text: Remove only incentive rule {id} on {incentive}.
        slots:
          id: path.Id
          incentive: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/incentives/{ParentId}/rules/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an incentive rule
      effect: write
      questions:
      - How do I edit one incentive rule?
      - Can I change a single rule on an incentive?
      instructions:
      - text: Update rule {id} of incentive {incentive}.
        slots:
          id: path.Id
          incentive: path.ParentId
      - text: Edit only incentive rule {id} on {incentive}.
        slots:
          id: path.Id
          incentive: path.ParentId
      method: generated
      generated: '2026-10-01'