Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Rebate Administration Rebate Rules API

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

$.paths['/rebates/{ParentId}/rules'].post

$.paths['/rebates/{ParentId}/rules'].delete

$.paths['/rebates/{ParentId}/rules'].patch

$.paths['/rebates/{ParentId}/rules/{Id}'].get

$.paths['/rebates/{ParentId}/rules/{Id}'].delete

$.paths['/rebates/{ParentId}/rules/{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 Rules API
  version: 1.0.0
extends: openapi/conga-rebate-rules-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}/rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List a rebate's rules
      effect: read
      questions:
      - Which rules are attached to a given rebate?
      - Can I filter or sort the rules of a rebate?
      instructions:
      - text: List the rules of rebate {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Show rules of rebate {ParentId} sorted by {sort}.
        slots:
          ParentId: path.ParentId
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rebates/{ParentId}/rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Add rules to a rebate
      effect: write
      questions:
      - How do I add rules to a rebate?
      - Can I create several rules under one rebate together?
      instructions:
      - text: Add rules to rebate {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Create new rules under rebate {ParentId}.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rebates/{ParentId}/rules'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several rules from a rebate
      effect: destructive
      questions:
      - Can I delete multiple rules from a rebate in one call?
      - What's the way to clear a batch of rules off a rebate?
      instructions:
      - text: Delete several rules from rebate {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Bulk-remove rules under rebate {ParentId}.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rebates/{ParentId}/rules'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update several rules on a rebate
      effect: write
      questions:
      - Is there a bulk update for a rebate's rules?
      - Can I reassign rules to another rebate while bulk-updating them?
      instructions:
      - text: Bulk-update the rules of rebate {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Apply changes to several rules in rebate {ParentId}.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rebates/{ParentId}/rules/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a rebate rule
      effect: read
      questions:
      - How do I look up a single rule on a rebate?
      - What does one specific rebate rule define?
      instructions:
      - text: Get rule {Id} of rebate {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Show rebate rule {Id} under rebate {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rebates/{ParentId}/rules/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a rebate rule
      effect: destructive
      questions:
      - How do I remove one rule from a rebate?
      - Can I delete a single rebate rule by its ID?
      instructions:
      - text: Delete rule {Id} from rebate {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Remove rebate rule {Id} under rebate {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rebates/{ParentId}/rules/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a rebate rule
      effect: write
      questions:
      - How do I edit a single rule on a rebate?
      - Can I change one rebate rule without touching the others?
      instructions:
      - text: Update rule {Id} of rebate {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Edit rebate rule {Id} under rebate {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'