Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Administration Incentive Rule Entries API

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