Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Administration Related Incentives API

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

$.paths['/incentives/{ParentId}/related-incentives'].post

$.paths['/incentives/{ParentId}/related-incentives'].delete

$.paths['/incentives/{ParentId}/related-incentives'].patch

$.paths['/incentives/{ParentId}/related-incentives/{Id}'].get

$.paths['/incentives/{ParentId}/related-incentives/{Id}'].delete

$.paths['/incentives/{ParentId}/related-incentives/{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 Administration Related Incentives API
  version: 1.0.0
extends: openapi/conga-related-incentives-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}/related-incentives'].get
  update:
    x-apievangelist-phrasing:
      intent: List an incentive's related incentives
      effect: read
      questions:
      - Which incentives are linked to a given incentive?
      - Can I filter or sort an incentive's related incentives?
      instructions:
      - text: List the related incentives of incentive {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Show related incentives under {ParentId} matching {filter}.
        slots:
          ParentId: path.ParentId
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/incentives/{ParentId}/related-incentives'].post
  update:
    x-apievangelist-phrasing:
      intent: Link related incentives to an incentive
      effect: write
      questions:
      - How do I relate other incentives to an incentive?
      - Can I add several related incentives in one call?
      instructions:
      - text: Add related incentives to incentive {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Link new related incentives under incentive {ParentId}.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/incentives/{ParentId}/related-incentives'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove several related incentives
      effect: destructive
      questions:
      - Can I unlink multiple related incentives from an incentive at once?
      - What's the way to clear a batch of related incentives?
      instructions:
      - text: Delete several related incentives from incentive {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Bulk-remove related incentives under incentive {ParentId}.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/incentives/{ParentId}/related-incentives'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update several related incentives
      effect: write
      questions:
      - Is there a bulk update for an incentive's related incentives?
      - Can I move related incentives to another parent while updating them?
      instructions:
      - text: Bulk-update the related incentives of incentive {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Apply changes to several related incentives under {ParentId}.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/incentives/{ParentId}/related-incentives/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a related incentive
      effect: read
      questions:
      - How do I look up one related incentive?
      - What details does a single related-incentive link hold?
      instructions:
      - text: Get related incentive {Id} of incentive {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Show related incentive {Id} under {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/incentives/{ParentId}/related-incentives/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a related incentive
      effect: destructive
      questions:
      - How do I unlink one related incentive from an incentive?
      - Can I delete a single related incentive by its ID?
      instructions:
      - text: Delete related incentive {Id} from incentive {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Unlink related incentive {Id} under {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/incentives/{ParentId}/related-incentives/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a related incentive
      effect: write
      questions:
      - How do I edit a single related incentive?
      - Can I change one related incentive without touching the others?
      instructions:
      - text: Update related incentive {Id} of incentive {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Edit related incentive {Id} under {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'