Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Administration Price Rule Entries API

8 actions 8 updates phrasing extends openapi/conga-price-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['/rules/{ParentId}/rule-entries'].get
$.paths['/rules/{ParentId}/rule-entries'].post
$.paths['/rules/{ParentId}/rule-entries'].delete
$.paths['/rules/{ParentId}/rule-entries'].patch
$.paths['/rules/{ParentId}/rule-entries/{Id}'].get
$.paths['/rules/{ParentId}/rule-entries/{Id}'].delete
$.paths['/rules/{ParentId}/rule-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 Administration Price Rule Entries API
  version: 1.0.0
extends: openapi/conga-price-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['/rules/{ParentId}/rule-entries'].get
  update:
    x-apievangelist-phrasing:
      intent: List the entries of a price rule
      effect: read
      questions:
      - How do I see all the entries inside one of my price rules?
      - Can I narrow down a price rule's entries with a filter or sort order?
      - Which price rule entries are defined under a given price rule in Conga CPQ?
      instructions:
      - text: List all entries in price rule {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Show entries of price rule {ParentId} matching {filter}.
        slots:
          ParentId: path.ParentId
          filter: query.filter
      - text: Get the first {limit} price rule entries for rule {ParentId}, sorted by {sort}.
        slots:
          limit: query.limit
          ParentId: path.ParentId
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rules/{ParentId}/rule-entries'].post
  update:
    x-apievangelist-phrasing:
      intent: Add entries to a price rule
      effect: write
      questions:
      - What's the way to add several new entries to a price rule at once?
      - Is there a limit on how many price rule entries I can create for one price rule?
      instructions:
      - text: Create a batch of new entries in price rule {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Add up to 100 new price rule entries to rule {ParentId}.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rules/{ParentId}/rule-entries'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several entries from a price rule
      effect: destructive
      questions:
      - How can I bulk delete entries from a condition or dimension price rule?
      - Does a bulk delete of price rule entries report a status for each record?
      instructions:
      - text: Bulk delete several entries from price rule {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Remove multiple price rule entries from rule {ParentId} in one request.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rules/{ParentId}/rule-entries'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update several entries of a price rule
      effect: write
      questions:
      - Can I change fields on many price rule entries in one bulk update?
      - Which fields of a price rule entry can't be changed in a bulk update?
      instructions:
      - text: Bulk update several entries in price rule {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Apply field changes to multiple price rule entries under rule {ParentId} together.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rules/{ParentId}/rule-entries/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one entry of a price rule
      effect: read
      questions:
      - How do I look up a single price rule entry by its ID?
      - What details are stored on one particular entry of a price rule?
      instructions:
      - text: Get price rule entry {Id} from rule {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Show the details of entry {Id} in price rule {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rules/{ParentId}/rule-entries/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one entry from a price rule
      effect: destructive
      questions:
      - How do I delete just one entry from a price rule?
      - Can I remove a single price rule entry by its ID and leave the rest?
      instructions:
      - text: Delete price rule entry {Id} from rule {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Remove only entry {Id} from price rule {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rules/{ParentId}/rule-entries/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update one entry of a price rule
      effect: write
      questions:
      - What do I call to edit a single price rule entry?
      - Can I change one specific entry in a price rule by its ID?
      instructions:
      - text: Update price rule entry {Id} in rule {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Edit just entry {Id} of price rule {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'