Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Rebate Administration Incentive Conditions API

8 actions 8 updates phrasing extends openapi/conga-incentive-conditions-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['/rebates/{ParentId}/conditions'].get
$.paths['/rebates/{ParentId}/conditions'].post
$.paths['/rebates/{ParentId}/conditions'].delete
$.paths['/rebates/{ParentId}/conditions'].patch
$.paths['/rebates/{ParentId}/conditions/{Id}'].get
$.paths['/rebates/{ParentId}/conditions/{Id}'].delete
$.paths['/rebates/{ParentId}/conditions/{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 Rebate Administration Incentive Conditions API
  version: 1.0.0
extends: openapi/conga-incentive-conditions-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['/rebates/{ParentId}/conditions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a rebate's incentive conditions
      effect: read
      questions:
      - What conditions apply to a rebate?
      - Can I filter the incentive conditions on a rebate?
      instructions:
      - text: List the incentive conditions of rebate {rebate}.
        slots:
          rebate: path.ParentId
      - text: Show conditions on rebate {rebate} matching {filter}.
        slots:
          rebate: path.ParentId
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rebates/{ParentId}/conditions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create incentive conditions on a rebate
      effect: write
      questions:
      - How do I add conditions to a rebate?
      - Can I create several rebate conditions at once?
      instructions:
      - text: Create incentive conditions on rebate {rebate}.
        slots:
          rebate: path.ParentId
      - text: Add new conditions to rebate {rebate}.
        slots:
          rebate: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rebates/{ParentId}/conditions'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete incentive conditions in bulk
      effect: destructive
      questions:
      - Can I remove many conditions from a rebate?
      - How do I bulk-delete rebate conditions?
      instructions:
      - text: Bulk delete incentive conditions on rebate {rebate}.
        slots:
          rebate: path.ParentId
      - text: Remove the selected conditions from rebate {rebate}.
        slots:
          rebate: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rebates/{ParentId}/conditions'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update incentive conditions in bulk
      effect: write
      questions:
      - Can I edit several rebate conditions in one call?
      - How do I bulk-update conditions on a rebate?
      instructions:
      - text: Bulk update incentive conditions on rebate {rebate}.
        slots:
          rebate: path.ParentId
      - text: Edit the selected conditions of rebate {rebate}.
        slots:
          rebate: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rebates/{ParentId}/conditions/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an incentive condition
      effect: read
      questions:
      - Where can I see one rebate condition?
      - What does a single incentive condition specify?
      instructions:
      - text: Get condition {id} on rebate {rebate}.
        slots:
          id: path.Id
          rebate: path.ParentId
      - text: Show incentive condition {id} of rebate {rebate}.
        slots:
          id: path.Id
          rebate: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rebates/{ParentId}/conditions/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an incentive condition
      effect: destructive
      questions:
      - Can I delete one condition from a rebate?
      - How do I remove a single incentive condition?
      instructions:
      - text: Delete condition {id} from rebate {rebate}.
        slots:
          id: path.Id
          rebate: path.ParentId
      - text: Remove only incentive condition {id} on rebate {rebate}.
        slots:
          id: path.Id
          rebate: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rebates/{ParentId}/conditions/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an incentive condition
      effect: write
      questions:
      - How do I edit one rebate condition?
      - Can I change a single incentive condition?
      instructions:
      - text: Update condition {id} on rebate {rebate}.
        slots:
          id: path.Id
          rebate: path.ParentId
      - text: Edit only incentive condition {id} of rebate {rebate}.
        slots:
          id: path.Id
          rebate: path.ParentId
      method: generated
      generated: '2026-10-01'