HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for HERE Tracking Traces API

5 actions 5 updates phrasing extends openapi/here-traces-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for HERE's API. It is a proposal applied on top of the contract, not a document HERE publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/traces/v2/health'].get

$.paths['/traces/v2/version'].get

$.paths['/traces/v2/{trackingId}'].get

$.paths['/traces/v2/{trackingId}'].delete

OpenAPI Overlay

# 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 Traces API
  version: 1.0.0
extends: openapi/here-traces-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['/traces/v2/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the Traces service health
      effect: read
      questions:
      - Is the HERE Tracking Traces service up right now?
      - Can I ping the Traces service before sending it requests?
      instructions:
      - text: Check the health of the Traces service.
      - text: Tell me whether the Traces service is healthy.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/traces/v2/version'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Traces service version
      effect: read
      questions:
      - What version of the Traces service is deployed?
      - Which build of the Traces service am I talking to?
      instructions:
      - text: Get the version of the Traces service.
      - text: Show me which Traces service version is running.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/traces/v2/{trackingId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a device's location history
      effect: read
      questions:
      - Where has a device been over the past day?
      - Can I get smoothed traces with outliers removed?
      instructions:
      - text: Get traces for device {trackingId} between {after} and {before}.
        slots:
          trackingId: path.trackingId
          after: query.after
          before: query.before
      - text: Show tracker {trackingId}'s path with smoothing {smooth}.
        slots:
          trackingId: path.trackingId
          smooth: query.smooth
      method: generated
      generated: '2026-10-01'
- target: $.paths['/traces/v2/{trackingId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a device's traces and events
      effect: destructive
      questions:
      - Can I erase a device's location history?
      - Does deleting traces also delete the device's event history?
      instructions:
      - text: Delete all traces of device {trackingId}.
        slots:
          trackingId: path.trackingId
      - text: Erase tracker {trackingId}'s location history and events.
        slots:
          trackingId: path.trackingId
      method: generated
      generated: '2026-10-01'