Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Incentive Administration Price Programs API

8 actions 8 updates phrasing extends openapi/conga-price-programs-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'].get
$.paths['/price-programs'].post
$.paths['/price-programs'].delete
$.paths['/price-programs'].patch
$.paths['/price-programs/{Id}'].get
$.paths['/price-programs/{Id}'].delete
$.paths['/price-programs/{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 Programs API
  version: 1.0.0
extends: openapi/conga-price-programs-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'].get
  update:
    x-apievangelist-phrasing:
      intent: List price program incentives
      effect: read
      questions:
      - How do I see all the price program incentives set up in Conga CPQ?
      - Can I filter and sort the list of incentives?
      - Which incentives exist across all my price programs?
      instructions:
      - text: List all price program incentives.
      - text: Show incentives matching {filter}, sorted by {sort}.
        slots:
          filter: query.filter
          sort: query.sort
      - text: Get page {page} of incentives with {limit} per page.
        slots:
          page: query.page
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-programs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create several incentives at once
      effect: write
      questions:
      - What's the way to create several new incentives in a single request?
      - Can I set up multiple price programs in bulk?
      instructions:
      - text: Create a batch of new price program incentives.
      - text: Set up several new incentives in one call.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-programs'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several incentives at once
      effect: destructive
      questions:
      - How can I bulk delete multiple incentives?
      - Is there a way to remove many price programs in a single request?
      instructions:
      - text: Bulk delete several price program incentives.
      - text: Remove multiple incentives in one request.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-programs'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update several incentives at once
      effect: write
      questions:
      - Can I update many incentives together in one bulk call?
      - What's the quickest way to change several price programs at the same time?
      instructions:
      - text: Bulk update several price program incentives.
      - text: Apply changes to multiple incentives in one request.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-programs/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one incentive by ID
      effect: read
      questions:
      - How do I look up a single incentive by its identifier?
      - Can I include related records when fetching one price program?
      instructions:
      - text: Get incentive {Id}.
        slots:
          Id: path.Id
      - text: Show price program {Id} including {includes}.
        slots:
          Id: path.Id
          includes: query.includes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-programs/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one incentive
      effect: destructive
      questions:
      - How do I delete a single incentive by its ID?
      - Can I remove just one price program without affecting the others?
      instructions:
      - text: Delete incentive {Id}.
        slots:
          Id: path.Id
      - text: Remove only price program {Id}.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-programs/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update one incentive
      effect: write
      questions:
      - What do I call to change the details of one specific incentive?
      - Can I edit a single price program by its ID?
      instructions:
      - text: Update incentive {Id}.
        slots:
          Id: path.Id
      - text: Edit just price program {Id}.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-10-01'