Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Incentive Administration Price Program Rules API

8 actions 8 updates phrasing extends openapi/conga-price-program-rules-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['/price-programs/{ParentId}/rules'].get
$.paths['/price-programs/{ParentId}/rules'].post
$.paths['/price-programs/{ParentId}/rules'].delete
$.paths['/price-programs/{ParentId}/rules'].patch
$.paths['/price-programs/{ParentId}/rules/{Id}'].get
$.paths['/price-programs/{ParentId}/rules/{Id}'].delete
$.paths['/price-programs/{ParentId}/rules/{Id}'].patch

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Incentive Administration Price Program Rules API
  version: 1.0.0
extends: openapi/conga-price-program-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['/price-programs/{ParentId}/rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List the incentive rules of a price program
      effect: read
      questions:
      - How do I see all the incentive rules attached to one price program?
      - Can I page through and filter the rules defined for an incentive?
      - Which incentive rules belong to a specific Conga price program?
      instructions:
      - text: List every incentive rule in price program {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Show page {page} of the rules for incentive {ParentId}, {limit} per page.
        slots:
          page: query.page
          ParentId: path.ParentId
          limit: query.limit
      - text: Find rules in price program {ParentId} matching {filter}.
        slots:
          ParentId: path.ParentId
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-programs/{ParentId}/rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Add incentive rules to a price program
      effect: write
      questions:
      - What's the way to add several new rules to an incentive in one call?
      - Does the parent incentive get set automatically when I create its rules?
      instructions:
      - text: Create a batch of new incentive rules under price program {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Add new rules to incentive {ParentId}.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-programs/{ParentId}/rules'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several incentive rules from a price program
      effect: destructive
      questions:
      - How can I bulk remove many rules from an incentive at once?
      - Can I clear out multiple price program rules in a single delete request?
      instructions:
      - text: Bulk delete several incentive rules from price program {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Remove a set of rules from incentive {ParentId} in one request.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-programs/{ParentId}/rules'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update several incentive rules of a price program
      effect: write
      questions:
      - Can I edit many incentive rules of a price program in one bulk update?
      - Is it possible to reassign incentive rules to another price program during a bulk update?
      instructions:
      - text: Bulk update several incentive rules in price program {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Apply changes to multiple rules of incentive {ParentId} at the same time.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-programs/{ParentId}/rules/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one incentive rule of a price program
      effect: read
      questions:
      - How do I look up a single incentive rule by its ID?
      - What is configured on one particular rule of my price program?
      instructions:
      - text: Get incentive rule {Id} from price program {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Show the details of rule {Id} in incentive {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-programs/{ParentId}/rules/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one incentive rule from a price program
      effect: destructive
      questions:
      - How do I delete a single incentive rule from a price program?
      - Can I remove one specific rule from an incentive by its ID?
      instructions:
      - text: Delete incentive rule {Id} from price program {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Remove only rule {Id} from incentive {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-programs/{ParentId}/rules/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update one incentive rule of a price program
      effect: write
      questions:
      - What do I call to change the settings of one incentive rule?
      - Can I edit a single price program rule by its ID?
      instructions:
      - text: Update incentive rule {Id} in price program {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Edit just rule {Id} of incentive {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'