Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Rebate Administration Rebate Programs API

8 actions 8 updates phrasing extends openapi/conga-rebate-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['/programs'].get

$.paths['/programs'].post

$.paths['/programs'].delete

$.paths['/programs'].patch

$.paths['/programs/{Id}'].get

$.paths['/programs/{Id}'].delete

$.paths['/programs/{Id}'].patch

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 Rebate Administration Rebate Programs API
  version: 1.0.0
extends: openapi/conga-rebate-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['/programs'].get
  update:
    x-apievangelist-phrasing:
      intent: List rebate programs
      effect: read
      questions:
      - Which rebate programs are set up in Conga Rebate Administration?
      - Can I filter and sort the list of rebate programs?
      instructions:
      - text: List all rebate programs.
      - text: Show rebate programs matching {filter}, sorted by {sort}.
        slots:
          filter: query.filter
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/programs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create rebate programs in bulk
      effect: write
      questions:
      - How do I create several rebate programs in one request?
      - Is it possible to load a batch of new rebate programs at once?
      instructions:
      - text: Create a batch of new rebate programs.
      - text: Bulk-add these rebate programs.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/programs'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete rebate programs in bulk
      effect: destructive
      questions:
      - Can I delete multiple rebate programs together?
      - What's the way to remove a batch of old rebate programs?
      instructions:
      - text: Delete these rebate programs in bulk.
      - text: Remove several rebate programs at once.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/programs'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update rebate programs in bulk
      effect: write
      questions:
      - Can I update many rebate programs in a single call?
      - Is there a bulk edit for rebate programs?
      instructions:
      - text: Bulk-update these rebate programs.
      - text: Apply my changes to several rebate programs at once.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/programs/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a rebate program
      effect: read
      questions:
      - How do I look up one rebate program by its ID?
      - Can I include related records when fetching a single rebate program?
      instructions:
      - text: Get rebate program {Id}.
        slots:
          Id: path.Id
      - text: Show rebate program {Id} with {includes} included.
        slots:
          Id: path.Id
          includes: query.includes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/programs/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a rebate program
      effect: destructive
      questions:
      - How do I delete a single rebate program?
      - Can a specific rebate program be removed by ID?
      instructions:
      - text: Delete rebate program {Id}.
        slots:
          Id: path.Id
      - text: Remove the rebate program with ID {Id}.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/programs/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a rebate program
      effect: write
      questions:
      - How do I edit one rebate program's details?
      - Can I change a specific rebate program by its ID?
      instructions:
      - text: Update rebate program {Id}.
        slots:
          Id: path.Id
      - text: Change the details of rebate program {Id}.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-10-01'