Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Administration Price Rules API

8 actions 8 updates phrasing extends openapi/conga-price-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['/rule-sets/{ParentId}/rules'].get
$.paths['/rule-sets/{ParentId}/rules'].post
$.paths['/rule-sets/{ParentId}/rules'].delete
$.paths['/rule-sets/{ParentId}/rules'].patch
$.paths['/rule-sets/{ParentId}/rules/{Id}'].get
$.paths['/rule-sets/{ParentId}/rules/{Id}'].delete
$.paths['/rule-sets/{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 Administration Price Rules API
  version: 1.0.0
extends: openapi/conga-price-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['/rule-sets/{ParentId}/rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List the price rules in a price rule set
      effect: read
      questions:
      - How do I see all the price rules inside one price rule set?
      - Can I filter or sort the price rules belonging to a rule set?
      - Which price rules make up a given Conga CPQ price rule set?
      instructions:
      - text: List all price rules in rule set {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Show price rules in rule set {ParentId} matching {filter}.
        slots:
          ParentId: path.ParentId
          filter: query.filter
      - text: Get page {page} of price rules for rule set {ParentId}, {limit} per page.
        slots:
          page: query.page
          ParentId: path.ParentId
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rule-sets/{ParentId}/rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Add price rules to a price rule set
      effect: write
      questions:
      - What's the way to add several new price rules to a rule set at once?
      - Do I get generated IDs back when I create price rules in a rule set?
      instructions:
      - text: Create a batch of new price rules in rule set {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Add new price rules to price rule set {ParentId}.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rule-sets/{ParentId}/rules'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several price rules from a rule set
      effect: destructive
      questions:
      - How many price rules can I bulk delete from a rule set in one call?
      - Does bulk deleting price rules also remove their price rule entries?
      instructions:
      - text: Bulk delete several price rules from rule set {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Remove up to 100 price rules and their entries from price rule set {ParentId}.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rule-sets/{ParentId}/rules'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update several price rules in a rule set
      effect: write
      questions:
      - Can I change fields on many price rules in one bulk update?
      - Which field of a price rule can't be modified in a bulk update?
      instructions:
      - text: Bulk update several price rules in rule set {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Apply field changes to multiple price rules of price rule set {ParentId} together.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rule-sets/{ParentId}/rules/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one price rule in a rule set
      effect: read
      questions:
      - How do I look up a single price rule by its ID?
      - What is configured on one particular price rule in a rule set?
      instructions:
      - text: Get price rule {Id} from rule set {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Show the details of price rule {Id} in price rule set {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rule-sets/{ParentId}/rules/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one price rule from a rule set
      effect: destructive
      questions:
      - How do I delete just one price rule from a rule set?
      - Can I remove a single price rule by its ID and keep the rest of the set?
      instructions:
      - text: Delete price rule {Id} from rule set {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Remove only price rule {Id} from price rule set {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rule-sets/{ParentId}/rules/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update one price rule in a rule set
      effect: write
      questions:
      - What do I call to edit a single price rule?
      - Can I change one specific price rule in a rule set by its ID?
      instructions:
      - text: Update price rule {Id} in rule set {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Edit just price rule {Id} of price rule set {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'