# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Hint Health Location API
  version: 1.0.0
extends: openapi/hint-health-location-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: 5
- target: $.paths['/provider/locations'].get
  update:
    x-apievangelist-phrasing:
      intent: List practice locations
      effect: read
      questions:
      - What clinic locations does the practice have?
      - Can I find locations within a certain distance of a zip code?
      instructions:
      - text: List all locations.
      - text: Find locations within {distance} of zip code {near_zip}.
        slots:
          distance: query.distance
          near_zip: query.near_zip
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/locations'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a practice location
      effect: write
      questions:
      - How do I add a new clinic location?
      - Can I set up a virtual location for telehealth visits?
      instructions:
      - text: Create a location named {name}.
        slots:
          name: requestBody.name
      - text: Add location {name} at {address_line1}, {address_city} {address_state} {address_zip}.
        slots:
          name: requestBody.name
          address_line1: requestBody.address_line1
          address_city: requestBody.address_city
          address_state: requestBody.address_state
          address_zip: requestBody.address_zip
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/locations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a location
      effect: read
      questions:
      - What address and phone number does a specific location have?
      - Is a particular location virtual?
      instructions:
      - text: Show location {id}.
        slots:
          id: path.id
      - text: Get the address of location {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/locations/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a location
      effect: destructive
      questions:
      - Can I delete a clinic location that has closed?
      - Is removing a location permanent?
      instructions:
      - text: Delete location {id}.
        slots:
          id: path.id
      - text: Remove location {id} from the practice.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/locations/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a location
      effect: write
      questions:
      - Can I change the phone number on an existing location?
      - Is it possible to move a location to a new address?
      instructions:
      - text: Rename location {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Update location {id} ({name}) with phone number {phone_number}.
        slots:
          id: path.id
          name: requestBody.name
          phone_number: requestBody.phone_number
      method: generated
      generated: '2026-10-01'