Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Incentive Administration Price Program Associations API

6 actions 6 updates phrasing extends openapi/conga-price-program-associations-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 6

$.info

$.paths['/business-objects/{businessObjectId}/price-program-associations'].delete

$.paths['/business-objects/{businessObjectId}/price-programs'].get

$.paths['/price-program-associations'].post

$.paths['/price-programs/{priceProgramId}/business-objects'].get

$.paths['/price-programs/{priceProgramId}/price-program-associations'].delete

OpenAPI Overlay

# 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 Associations API
  version: 1.0.0
extends: openapi/conga-price-program-associations-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: 5
- target: $.paths['/business-objects/{businessObjectId}/price-program-associations'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove price programs from a business object
      effect: destructive
      questions:
      - Can I detach price programs from an account or other business object?
      - How do I disassociate specific price programs from a record?
      instructions:
      - text: Remove price programs {programs} from business object {obj}.
        slots:
          programs: requestBody.PriceProgramIds
          obj: path.businessObjectId
      - text: Detach all listed price programs from {obj}.
        slots:
          obj: path.businessObjectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/business-objects/{businessObjectId}/price-programs'].get
  update:
    x-apievangelist-phrasing:
      intent: List price programs on a business object
      effect: read
      questions:
      - Which price programs are linked to a business object?
      - Can I filter the price programs associated with a record?
      instructions:
      - text: List price programs associated with business object {obj}.
        slots:
          obj: path.businessObjectId
      - text: Show price programs on {obj} matching {filter}.
        slots:
          obj: path.businessObjectId
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-program-associations'].post
  update:
    x-apievangelist-phrasing:
      intent: Associate price programs with business objects
      effect: write
      questions:
      - How do I link a price program to accounts or other business objects?
      - Can I create several price program associations at once?
      instructions:
      - text: Associate price programs with business objects.
      - text: Create new price program associations.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-programs/{priceProgramId}/business-objects'].get
  update:
    x-apievangelist-phrasing:
      intent: List business objects on a price program
      effect: read
      questions:
      - Which accounts or business objects belong to a price program?
      - Can I list a price program's business objects of one type?
      instructions:
      - text: List {type} business objects associated with price program {program}.
        slots:
          type: query.type
          program: path.priceProgramId
      - text: Show {type} records linked to price program {program}.
        slots:
          type: query.type
          program: path.priceProgramId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-programs/{priceProgramId}/price-program-associations'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove business objects from a price program
      effect: destructive
      questions:
      - Can I detach business objects from a price program?
      - How do I disassociate specific records from a price program?
      instructions:
      - text: Remove business objects {objs} from price program {program}.
        slots:
          objs: requestBody.BusinessObjectIds
          program: path.priceProgramId
      - text: Detach listed records from price program {program}.
        slots:
          program: path.priceProgramId
      method: generated
      generated: '2026-10-01'