Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Rebate Administration Rebate Rule Entries API

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

$.paths['/rebate-rules/{ParentId}/entries'].post

$.paths['/rebate-rules/{ParentId}/entries'].delete

$.paths['/rebate-rules/{ParentId}/entries'].patch

$.paths['/rebate-rules/{ParentId}/entries/{Id}'].get

$.paths['/rebate-rules/{ParentId}/entries/{Id}'].delete

$.paths['/rebate-rules/{ParentId}/entries/{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 Rule Entries API
  version: 1.0.0
extends: openapi/conga-rebate-rule-entries-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['/rebate-rules/{ParentId}/entries'].get
  update:
    x-apievangelist-phrasing:
      intent: List a rebate rule's entries
      effect: read
      questions:
      - Which entries belong to a given rebate rule?
      - Can I filter or page through a rebate rule's entries?
      instructions:
      - text: List the entries of rebate rule {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Show entries of rebate rule {ParentId} matching {filter}.
        slots:
          ParentId: path.ParentId
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rebate-rules/{ParentId}/entries'].post
  update:
    x-apievangelist-phrasing:
      intent: Add entries to a rebate rule
      effect: write
      questions:
      - How do I add entries to a rebate rule?
      - Can I create several rule entries under one rebate rule at once?
      instructions:
      - text: Add entries to rebate rule {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Create new rule entries under rebate rule {ParentId}.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rebate-rules/{ParentId}/entries'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several rebate rule entries
      effect: destructive
      questions:
      - Can I delete multiple entries from a rebate rule in one request?
      - What's the way to clear out a batch of a rebate rule's entries?
      instructions:
      - text: Delete several entries from rebate rule {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Bulk-remove entries under rebate rule {ParentId}.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rebate-rules/{ParentId}/entries'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update several rebate rule entries
      effect: write
      questions:
      - Is there a bulk update for a rebate rule's entries?
      - Can I move an entry to a different rebate rule while updating it?
      instructions:
      - text: Bulk-update the entries of rebate rule {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Apply changes to several entries in rebate rule {ParentId}.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rebate-rules/{ParentId}/entries/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a rebate rule entry
      effect: read
      questions:
      - How do I look up a single entry on a rebate rule?
      - What does one specific rebate rule entry contain?
      instructions:
      - text: Get entry {Id} of rebate rule {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Show rebate rule entry {Id} under rule {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rebate-rules/{ParentId}/entries/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a rebate rule entry
      effect: destructive
      questions:
      - How do I remove one entry from a rebate rule?
      - Can I delete a single rebate rule entry by ID?
      instructions:
      - text: Delete entry {Id} from rebate rule {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Remove rebate rule entry {Id} under rule {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rebate-rules/{ParentId}/entries/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a rebate rule entry
      effect: write
      questions:
      - How do I edit a single rebate rule entry?
      - Can I change one entry on a rebate rule without touching the others?
      instructions:
      - text: Update entry {Id} of rebate rule {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Edit rebate rule entry {Id} under rule {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'