# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for HERE Tracking Locations API
  version: 1.0.0
extends: openapi/here-locations-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: 8
- target: $.paths['/locations/v4/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the Locations service health
      effect: read
      questions:
      - Is the HERE Tracking Locations service up right now?
      - Can I ping the Locations service before sending it requests?
      instructions:
      - text: Check the health of the Locations service.
      - text: Tell me whether the Locations service is healthy.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/locations/v4/version'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Locations service version
      effect: read
      questions:
      - What version of the Locations service is deployed?
      - Which build of the Locations service am I talking to?
      instructions:
      - text: Get the version of the Locations service.
      - text: Show me which Locations service version is running.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/locations/v4'].get
  update:
    x-apievangelist-phrasing:
      intent: List saved locations in a project
      effect: read
      questions:
      - Which locations have I saved in my tracking project?
      - Can I search my saved locations by city or postal code?
      instructions:
      - text: List all locations in project {projectId}.
        slots:
          projectId: query.projectId
      - text: Find saved locations in city {city} with postal code {postalCode}.
        slots:
          city: query.city
          postalCode: query.postalCode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/locations/v4'].post
  update:
    x-apievangelist-phrasing:
      intent: Save a new location
      effect: write
      questions:
      - How do I save a warehouse or customer site as a location?
      - Can a location be defined by a geofence instead of coordinates?
      instructions:
      - text: Create a location named {name} at {location}.
        slots:
          name: requestBody.name
          location: requestBody.location
      - text: Save location {name} using geofence {geofenceId}.
        slots:
          name: requestBody.name
          geofenceId: requestBody.geofenceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/locations/v4'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete every location in a project
      effect: destructive
      questions:
      - Can I remove all saved locations from a project at once?
      - What confirmation is required to wipe all my locations?
      instructions:
      - text: Delete all locations in project {projectId} with x-confirm {confirm}.
        slots:
          projectId: query.projectId
          confirm: header.x-confirm
      - text: Remove every saved location, confirming with {confirm}.
        slots:
          confirm: header.x-confirm
      method: generated
      generated: '2026-10-01'
- target: $.paths['/locations/v4/{locationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one saved location
      effect: read
      questions:
      - What are the details of one saved location?
      - Can I look up a location's address by its ID?
      instructions:
      - text: Get location {locationId}.
        slots:
          locationId: path.locationId
      - text: Show the address and coordinates of location {locationId}.
        slots:
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/locations/v4/{locationId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a saved location's details
      effect: write
      questions:
      - Can I change the address or coordinates of a saved location?
      - Does updating a location replace its old definition entirely?
      instructions:
      - text: Update location {locationId} with name {name} and address {address}.
        slots:
          locationId: path.locationId
          name: requestBody.name
          address: requestBody.address
      - text: Move location {locationId} to coordinates {location}.
        slots:
          locationId: path.locationId
          location: requestBody.location
      method: generated
      generated: '2026-10-01'
- target: $.paths['/locations/v4/{locationId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one saved location
      effect: destructive
      questions:
      - Can I delete a location that a shipment still refers to?
      - What removes a single saved location?
      instructions:
      - text: Delete location {locationId}.
        slots:
          locationId: path.locationId
      - text: Remove the saved location {locationId}.
        slots:
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'