# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Antavo Display Challenges API
  version: 1.0.0
extends: openapi/antavo-challenges-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: 4
- target: $.paths['/customers/{customer_id}/activities/challenges'].get
  update:
    x-apievangelist-phrasing:
      intent: List open challenges for a customer
      effect: read
      questions:
      - Which challenges can a member still complete?
      - Is there a simple unfiltered list of a customer's active challenges?
      instructions:
      - text: List the open challenges for customer {customer_id}.
        slots:
          customer_id: path.customer_id
      - text: Show all active challenges customer {customer_id} can take on, unfiltered.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customers/{customer_id}/challenges'].get
  update:
    x-apievangelist-phrasing:
      intent: List a customer's completed challenges
      effect: read
      questions:
      - Which challenges has a member already completed?
      - Is there a basic challenge completion history for a customer?
      instructions:
      - text: List the challenges customer {customer_id} has completed.
        slots:
          customer_id: path.customer_id
      - text: Show customer {customer_id}'s challenge completion history from the v1 endpoint.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/customers/{customer_id}/activities/challenges'].get
  update:
    x-apievangelist-phrasing:
      intent: Filter available challenges for a customer
      effect: read
      questions:
      - Can I filter a customer's available challenges by tag or points?
      - Can I sort the challenges a member can take by title?
      instructions:
      - text: List available challenges for customer {customer_id} tagged {tags}.
        slots:
          customer_id: path.customer_id
          tags: query.tags
      - text: Show {limit} challenges customer {customer_id} can complete worth {points} points, sorted by {sort} {order}.
        slots:
          limit: query.limit
          customer_id: path.customer_id
          points: query.points
          sort: query.sort
          order: query.order
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/customers/{customer_id}/challenges'].get
  update:
    x-apievangelist-phrasing:
      intent: Filter a customer's completed challenges by date
      effect: read
      questions:
      - Can I see challenges a member completed within a date range?
      - Can I filter completed challenges by when they were last finished?
      instructions:
      - text: List challenges customer {customer_id} first completed after {after}.
        slots:
          customer_id: path.customer_id
          after: query.created_at.gt
      - text: Show customer {customer_id}'s completed challenges last finished before {before}.
        slots:
          customer_id: path.customer_id
          before: query.last_completed_at.lt
      method: generated
      generated: '2026-10-01'