Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Administration Incentive Limits API

8 actions 8 updates phrasing extends openapi/conga-incentive-limits-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['/incentives/{ParentId}/limits'].get
$.paths['/incentives/{ParentId}/limits'].post
$.paths['/incentives/{ParentId}/limits'].delete
$.paths['/incentives/{ParentId}/limits'].patch
$.paths['/incentives/{ParentId}/limits/{Id}'].get
$.paths['/incentives/{ParentId}/limits/{Id}'].delete
$.paths['/incentives/{ParentId}/limits/{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 Administration Incentive Limits API
  version: 1.0.0
extends: openapi/conga-incentive-limits-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['/incentives/{ParentId}/limits'].get
  update:
    x-apievangelist-phrasing:
      intent: List an incentive's limits
      effect: read
      questions:
      - What usage limits apply to an incentive?
      - Can I filter the limits set on an incentive?
      instructions:
      - text: List limits of incentive {incentive}.
        slots:
          incentive: path.ParentId
      - text: Show limits on incentive {incentive} matching {filter}.
        slots:
          incentive: path.ParentId
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/incentives/{ParentId}/limits'].post
  update:
    x-apievangelist-phrasing:
      intent: Create incentive limits
      effect: write
      questions:
      - How do I cap how often an incentive can be used?
      - Can I add several limits to one incentive?
      instructions:
      - text: Create limits on incentive {incentive}.
        slots:
          incentive: path.ParentId
      - text: Add usage caps to incentive {incentive}.
        slots:
          incentive: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/incentives/{ParentId}/limits'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete incentive limits in bulk
      effect: destructive
      questions:
      - Can I remove many limits from an incentive?
      - How do I bulk-delete incentive limits?
      instructions:
      - text: Bulk delete limits on incentive {incentive}.
        slots:
          incentive: path.ParentId
      - text: Remove the selected limits from incentive {incentive}.
        slots:
          incentive: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/incentives/{ParentId}/limits'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update incentive limits in bulk
      effect: write
      questions:
      - Can I edit several incentive limits in one call?
      - How do I bulk-update the caps on an incentive?
      instructions:
      - text: Bulk update limits on incentive {incentive}.
        slots:
          incentive: path.ParentId
      - text: Edit the selected limits of incentive {incentive}.
        slots:
          incentive: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/incentives/{ParentId}/limits/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an incentive limit
      effect: read
      questions:
      - Where can I see one incentive limit?
      - What cap does a specific limit record set?
      instructions:
      - text: Get limit {id} of incentive {incentive}.
        slots:
          id: path.Id
          incentive: path.ParentId
      - text: Show limit record {id} on {incentive}.
        slots:
          id: path.Id
          incentive: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/incentives/{ParentId}/limits/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an incentive limit
      effect: destructive
      questions:
      - Can I delete a single incentive limit?
      - How do I lift one cap on an incentive?
      instructions:
      - text: Delete limit {id} from incentive {incentive}.
        slots:
          id: path.Id
          incentive: path.ParentId
      - text: Remove only limit {id} on {incentive}.
        slots:
          id: path.Id
          incentive: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/incentives/{ParentId}/limits/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an incentive limit
      effect: write
      questions:
      - How do I change one incentive limit?
      - Can I raise a single cap on an incentive?
      instructions:
      - text: Update limit {id} of incentive {incentive}.
        slots:
          id: path.Id
          incentive: path.ParentId
      - text: Edit only limit {id} on {incentive}.
        slots:
          id: path.Id
          incentive: path.ParentId
      method: generated
      generated: '2026-10-01'