# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Close Outcomes API
  version: 1.0.0
extends: openapi/close-outcomes-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/outcome/'].get
  update:
    x-apievangelist-phrasing:
      intent: List call and meeting outcomes
      effect: read
      questions:
      - What outcomes can reps pick after a call or meeting?
      - Can I page through all our outcomes?
      instructions:
      - text: List our outcomes.
      - text: Show {limit} outcomes.
        slots:
          limit: query._limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/outcome/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an outcome
      effect: write
      questions:
      - How do I add a new call outcome like Left Voicemail?
      - Can an outcome apply only to meetings?
      instructions:
      - text: Create an outcome named {name}.
        slots:
          name: requestBody.name
      - text: Create outcome {name} that applies to {applies_to}.
        slots:
          name: requestBody.name
          applies_to: requestBody.applies_to
      method: generated
      generated: '2026-09-26'
- target: $.paths['/outcome/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single outcome
      effect: read
      questions:
      - How do I look up one outcome's definition?
      - What does a specific outcome apply to?
      instructions:
      - text: Show outcome {id}.
        slots:
          id: path.id
      - text: Fetch the definition of outcome {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/outcome/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit an outcome
      effect: write
      questions:
      - Can I rename an outcome reps are already using?
      - How do I change the description of an outcome?
      instructions:
      - text: Rename outcome {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Set the description of outcome {id} to {description}.
        slots:
          id: path.id
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/outcome/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an outcome
      effect: destructive
      questions:
      - Do calls keep their outcome if I delete it?
      - How do I retire an outcome so no one can pick it?
      instructions:
      - text: Delete outcome {id}.
        slots:
          id: path.id
      - text: Remove outcome {id} so it can't be set on new calls.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'