Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Incentive Administration Price Program Rule Entries API

8 actions 8 updates phrasing extends openapi/conga-price-program-rule-entries-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-program-rules/{ParentId}/entries'].get
$.paths['/price-program-rules/{ParentId}/entries'].post
$.paths['/price-program-rules/{ParentId}/entries'].delete
$.paths['/price-program-rules/{ParentId}/entries'].patch
$.paths['/price-program-rules/{ParentId}/entries/{Id}'].get
$.paths['/price-program-rules/{ParentId}/entries/{Id}'].delete
$.paths['/price-program-rules/{ParentId}/entries/{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 Rule Entries API
  version: 1.0.0
extends: openapi/conga-price-program-rule-entries-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-program-rules/{ParentId}/entries'].get
  update:
    x-apievangelist-phrasing:
      intent: List the entries of a price program incentive rule
      effect: read
      questions:
      - How do I see every entry defined under one of my price program incentive rules?
      - Can I filter and sort the incentive rule entries that belong to a price program rule?
      - Which entries make up a given incentive rule in Conga CPQ price programs?
      instructions:
      - text: List all entries under incentive rule {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Show the first {limit} entries of price program rule {ParentId}, sorted by {sort}.
        slots:
          limit: query.limit
          ParentId: path.ParentId
          sort: query.sort
      - text: Find entries in incentive rule {ParentId} that match {filter}.
        slots:
          ParentId: path.ParentId
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-program-rules/{ParentId}/entries'].post
  update:
    x-apievangelist-phrasing:
      intent: Add entries to a price program incentive rule
      effect: write
      questions:
      - How can I add several new entries to an incentive rule in one request?
      - Is the parent incentive rule filled in automatically when I create rule entries?
      instructions:
      - text: Add a batch of new entries to incentive rule {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Create new incentive rule entries under price program rule {ParentId}.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-program-rules/{ParentId}/entries'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several entries from an incentive rule
      effect: destructive
      questions:
      - How do I remove many entries from an incentive rule at once?
      - Can I bulk delete incentive rule entries instead of removing them one by one?
      instructions:
      - text: Bulk delete several entries from incentive rule {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Remove a set of incentive rule entries from price program rule {ParentId} in one call.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-program-rules/{ParentId}/entries'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update several entries of an incentive rule at once
      effect: write
      questions:
      - How can I edit many incentive rule entries in a single bulk update?
      - Can I move incentive rule entries to a different parent rule when bulk updating them?
      instructions:
      - text: Bulk update several entries in incentive rule {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Apply changes to multiple incentive rule entries under price program rule {ParentId} together.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-program-rules/{ParentId}/entries/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one entry of an incentive rule
      effect: read
      questions:
      - How do I look up a single incentive rule entry by its ID?
      - What details are stored on one specific entry of a price program incentive rule?
      instructions:
      - text: Get incentive rule entry {Id} from rule {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Show me the details of entry {Id} in price program rule {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-program-rules/{ParentId}/entries/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one entry from an incentive rule
      effect: destructive
      questions:
      - How do I delete just one entry from an incentive rule?
      - Can I remove a single incentive rule entry by its ID without touching the others?
      instructions:
      - text: Delete incentive rule entry {Id} from rule {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Remove only entry {Id} from price program rule {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-program-rules/{ParentId}/entries/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update one entry of an incentive rule
      effect: write
      questions:
      - How do I change the values on one specific incentive rule entry?
      - Can I edit a single price program rule entry by its ID?
      instructions:
      - text: Update incentive rule entry {Id} in rule {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Edit just entry {Id} of price program rule {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'