Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Administration Price Rule Sets API

8 actions 8 updates phrasing extends openapi/conga-price-rule-sets-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'].get
$.paths['/rule-sets'].post
$.paths['/rule-sets'].delete
$.paths['/rule-sets'].patch
$.paths['/rule-sets/{Id}'].get
$.paths['/rule-sets/{Id}'].delete
$.paths['/rule-sets/{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 Sets API
  version: 1.0.0
extends: openapi/conga-price-rule-sets-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'].get
  update:
    x-apievangelist-phrasing:
      intent: List price rule sets
      effect: read
      questions:
      - How do I see all the price rule sets configured in Conga CPQ?
      - Can I filter or sort the list of price rule sets?
      - Which price rule sets do we currently have?
      instructions:
      - text: List all price rule sets.
      - text: Show price rule sets matching {filter}, sorted by {sort}.
        slots:
          filter: query.filter
          sort: query.sort
      - text: Get page {page} of price rule sets, {limit} at a time.
        slots:
          page: query.page
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rule-sets'].post
  update:
    x-apievangelist-phrasing:
      intent: Create price rule sets
      effect: write
      questions:
      - What's the way to create one or more new price rule sets?
      - Does creating a price rule set return a generated ID I can use later?
      instructions:
      - text: Create a batch of new price rule sets.
      - text: Set up several new price rule sets in one request.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rule-sets'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several price rule sets
      effect: destructive
      questions:
      - How many price rule sets can I bulk delete in one call?
      - Does bulk deleting price rule sets also remove their price rules and entries?
      instructions:
      - text: Bulk delete several price rule sets along with their rules and entries.
      - text: Remove up to 100 price rule sets in one request.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rule-sets'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update several price rule sets
      effect: write
      questions:
      - Can I change fields on many price rule sets in one bulk update?
      - Is there any field on a price rule set that a bulk update can't change?
      instructions:
      - text: Bulk update several price rule sets.
      - text: Apply field changes to multiple price rule sets at once.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rule-sets/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one price rule set
      effect: read
      questions:
      - How do I look up a single price rule set by its ID?
      - Can I include related records when fetching one price rule set?
      instructions:
      - text: Get price rule set {Id}.
        slots:
          Id: path.Id
      - text: Show price rule set {Id} including {includes}.
        slots:
          Id: path.Id
          includes: query.includes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rule-sets/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one price rule set
      effect: destructive
      questions:
      - How do I delete a single price rule set by its ID?
      - Can I remove just one price rule set and keep the others?
      instructions:
      - text: Delete price rule set {Id}.
        slots:
          Id: path.Id
      - text: Remove only rule set {Id} from pricing.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rule-sets/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update one price rule set
      effect: write
      questions:
      - What do I call to edit a single price rule set?
      - Can I change the details of one specific price rule set by its ID?
      instructions:
      - text: Update price rule set {Id}.
        slots:
          Id: path.Id
      - text: Edit just rule set {Id} in pricing.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-10-01'