# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Elation Health Vaccine API
  version: 1.0.0
extends: openapi/elation-health-vaccine-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: 4
- target: $.paths['/api/2.0/vaccine/'].get
  update:
    x-apievangelist-phrasing:
      intent: List vaccines
      effect: read
      questions:
      - How do I look up a vaccine by its CVX code?
      - Can I list only the vaccines my practice created itself?
      - Which vaccines fall under a given CDC type?
      instructions:
      - text: List vaccines with CVX code {cvx}.
        slots:
          cvx: query.cvx
      - text: Show vaccines of CDC type {cdc_type} for practice {practice}.
        slots:
          cdc_type: query.cdc_type
          practice: query.practice
      - text: Find vaccines named {name} with creation type {creation_type}.
        slots:
          name: query.name
          creation_type: query.creation_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/vaccine/'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a vaccine to the practice list
      effect: write
      questions:
      - How do I add a custom vaccine with its NDC to our practice?
      - Can I record a new vaccine's CVX code and description?
      instructions:
      - text: Create vaccine {name} with CVX {cvx} and NDC {ndc}.
        slots:
          name: requestBody.name
          cvx: requestBody.cvx
          ndc: requestBody.ndc
      - text: Add a user-created vaccine for practice {practice} described as {description}.
        slots:
          practice: requestBody.practice
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/vaccine/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a vaccine
      effect: read
      questions:
      - How do I see the CVX and NDC details for one vaccine?
      - Was a particular vaccine entry user-created?
      instructions:
      - text: Retrieve vaccine {id}.
        slots:
          id: path.id
      - text: Show the codes on vaccine record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/vaccine/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a vaccine
      effect: destructive
      questions:
      - How do I remove a vaccine entry we added by mistake?
      - Can I delete a vaccine from the practice list?
      instructions:
      - text: Delete vaccine {id}.
        slots:
          id: path.id
      - text: Remove vaccine entry {id} from our list.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'