# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Incentive Administration Incentive Programs API
  version: 1.0.0
extends: openapi/conga-incentive-programs-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-programs'].get
  update:
    x-apievangelist-phrasing:
      intent: List incentive programs
      effect: read
      questions:
      - Which incentive programs are set up?
      - Can I filter or page through incentive programs?
      instructions:
      - text: List all incentive programs.
      - text: List incentive programs matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/incentive-programs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create incentive programs
      effect: write
      questions:
      - How do I create a new incentive program?
      - Can I create several programs at once?
      instructions:
      - text: Create new incentive programs.
      - text: Add a batch of incentive programs.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/incentive-programs'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete incentive programs in bulk
      effect: destructive
      questions:
      - Can I delete several incentive programs at once?
      - How do I bulk-remove incentive programs?
      instructions:
      - text: Bulk delete the selected incentive programs.
      - text: Remove many incentive programs in one call.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/incentive-programs'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update incentive programs in bulk
      effect: write
      questions:
      - Can I edit multiple incentive programs in one request?
      - How do I bulk-update incentive programs?
      instructions:
      - text: Bulk update the selected incentive programs.
      - text: Edit several incentive programs at once.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/incentive-programs/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an incentive program
      effect: read
      questions:
      - Where can I see one incentive program?
      - Can I include related records when fetching a program?
      instructions:
      - text: Get incentive program {id}.
        slots:
          id: path.Id
      - text: Show incentive program {id} including {includes}.
        slots:
          id: path.Id
          includes: query.includes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/incentive-programs/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an incentive program
      effect: destructive
      questions:
      - Can I delete a single incentive program?
      - What happens when one program is removed?
      instructions:
      - text: Delete incentive program {id}.
        slots:
          id: path.Id
      - text: Remove only the incentive program {id}.
        slots:
          id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/incentive-programs/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an incentive program
      effect: write
      questions:
      - How do I edit one incentive program?
      - Can I change a single program's dates?
      instructions:
      - text: Update incentive program {id}.
        slots:
          id: path.Id
      - text: Edit only the incentive program {id}.
        slots:
          id: path.Id
      method: generated
      generated: '2026-10-01'