Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Conga Rebates API

10 actions 10 updates phrasing extends openapi/conga-rebates-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 10

$.info

$.paths['/api/cart/v1/carts/{cartId}/rebate-estimates'].post

$.paths['/rebates'].get

$.paths['/rebates'].post

$.paths['/rebates'].delete

$.paths['/rebates'].patch

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

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

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

$.paths['/rebates/{Id}/clone'].post

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 Conga Rebates API
  version: 1.0.0
extends: openapi/conga-rebates-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: 9
- target: $.paths['/api/cart/v1/carts/{cartId}/rebate-estimates'].post
  update:
    x-apievangelist-phrasing:
      intent: Estimate rebates for a cart
      effect: read
      questions:
      - What rebates would the customer earn on the products in this cart?
      - Can I preview estimated rebate amounts on a quote cart before finalizing it?
      instructions:
      - text: Estimate the rebates for cart {cartId}.
        slots:
          cartId: path.cartId
      - text: Show the estimated rebate details for cart {cartId}.
        slots:
          cartId: path.cartId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rebates'].get
  update:
    x-apievangelist-phrasing:
      intent: List rebates
      effect: read
      questions:
      - Which rebates are defined in Conga?
      - Can I filter or page through the list of rebates?
      instructions:
      - text: List all rebates.
      - text: Show rebates matching {filter}, {limit} per page.
        slots:
          filter: query.filter
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rebates'].post
  update:
    x-apievangelist-phrasing:
      intent: Create rebates in bulk
      effect: write
      questions:
      - How do I create several rebates in one request?
      - Is it possible to load a batch of new rebates at once?
      instructions:
      - text: Create a batch of new rebates.
      - text: Bulk-add these rebates.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rebates'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete rebates in bulk
      effect: destructive
      questions:
      - Can I delete multiple rebates together?
      - What's the way to remove a batch of expired rebates?
      instructions:
      - text: Delete these rebates in bulk.
      - text: Remove several rebates at once.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rebates'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update rebates in bulk
      effect: write
      questions:
      - Can I update many rebates in a single call?
      - Is there a bulk edit for rebates?
      instructions:
      - text: Bulk-update these rebates.
      - text: Apply my changes to several rebates at once.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rebates/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a rebate
      effect: read
      questions:
      - How do I look up one rebate by its ID?
      - Can I include related records when fetching a single rebate?
      instructions:
      - text: Get rebate {Id}.
        slots:
          Id: path.Id
      - text: Show rebate {Id} with {includes} included.
        slots:
          Id: path.Id
          includes: query.includes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rebates/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a rebate
      effect: destructive
      questions:
      - How do I delete a single rebate?
      - Can a specific rebate be removed by its ID?
      instructions:
      - text: Delete rebate {Id}.
        slots:
          Id: path.Id
      - text: Remove the rebate with ID {Id}.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rebates/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a rebate
      effect: write
      questions:
      - How do I edit one rebate's details?
      - Can I change a specific rebate by its ID?
      instructions:
      - text: Update rebate {Id}.
        slots:
          Id: path.Id
      - text: Change the details of rebate {Id}.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rebates/{Id}/clone'].post
  update:
    x-apievangelist-phrasing:
      intent: Clone a rebate
      effect: write
      questions:
      - Can I copy an existing rebate to start a new one?
      - Is it possible to clone a rebate asynchronously?
      instructions:
      - text: Clone rebate {Id}.
        slots:
          Id: path.Id
      - text: Clone rebate {Id} with async mode set to {isAsync}.
        slots:
          Id: path.Id
          isAsync: query.isAsync
      method: generated
      generated: '2026-10-01'