API Evangelist conversational phrasing for HERE Tracking Associations API

# 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 Associations API
  version: 1.0.0
extends: openapi/here-associations-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: 17
- target: $.paths['/associations/v3/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the Associations service health
      effect: read
      questions:
      - Is the HERE Tracking Associations service up right now?
      - Can I ping the Associations service before sending it requests?
      instructions:
      - text: Check the health of the Associations service.
      - text: Tell me whether the Associations service is healthy.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/associations/v3/version'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Associations service version
      effect: read
      questions:
      - What version of the Associations service is deployed?
      - Which build of the Associations service am I talking to?
      instructions:
      - text: Get the version of the Associations service.
      - text: Show me which Associations service version is running.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/associations/v3/sensors/{sensorRuleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List devices linked to a sensor rule
      effect: read
      questions:
      - Which devices are using a particular sensor rule?
      - Can I see every tracker associated with one sensor rule?
      instructions:
      - text: List the devices associated with sensor rule {sensorRuleId}.
        slots:
          sensorRuleId: path.sensorRuleId
      - text: Show which trackers sensor rule {sensorRuleId} applies to.
        slots:
          sensorRuleId: path.sensorRuleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/associations/v3/geofences/{geofenceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List devices linked to a geofence
      effect: read
      questions:
      - Which devices are associated with a specific geofence?
      - What trackers generate events for one geofence?
      instructions:
      - text: List the devices associated with geofence {geofenceId}.
        slots:
          geofenceId: path.geofenceId
      - text: Show which trackers are watched by geofence {geofenceId}.
        slots:
          geofenceId: path.geofenceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/associations/v3/rules/{ruleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List devices linked to a rule
      effect: read
      questions:
      - Which devices are associated with a given tracking rule?
      - Can I find all trackers a detention or dwelling rule applies to?
      instructions:
      - text: Find all trackers bound to tracking rule {ruleId}.
        slots:
          ruleId: path.ruleId
      - text: Show which trackers rule {ruleId} is attached to.
        slots:
          ruleId: path.ruleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/associations/v3/{trackingId}/sensors/{sensorRuleId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Attach a sensor rule to a device
      effect: write
      questions:
      - How do I activate a sensor rule on a tracker?
      - Can a device have more than one sensor rule of the same sensor type?
      instructions:
      - text: Associate device {trackingId} with sensor rule {sensorRuleId}.
        slots:
          trackingId: path.trackingId
          sensorRuleId: path.sensorRuleId
      - text: Apply sensor rule {sensorRuleId} to tracker {trackingId}.
        slots:
          sensorRuleId: path.sensorRuleId
          trackingId: path.trackingId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/associations/v3/{trackingId}/sensors/{sensorRuleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Detach a sensor rule from a device
      effect: destructive
      questions:
      - Can I stop a sensor rule from applying to one tracker?
      - What removes the link between a device and a sensor rule?
      instructions:
      - text: Disassociate device {trackingId} from sensor rule {sensorRuleId}.
        slots:
          trackingId: path.trackingId
          sensorRuleId: path.sensorRuleId
      - text: Remove sensor rule {sensorRuleId} from tracker {trackingId}.
        slots:
          sensorRuleId: path.sensorRuleId
          trackingId: path.trackingId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/associations/v3/{trackingId}/geofences/{geofenceId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Attach a geofence to a device
      effect: write
      questions:
      - How do I get enter and exit events when a tracker crosses a geofence?
      - Can I link one device to a specific geofence?
      instructions:
      - text: Associate device {trackingId} with geofence {geofenceId}.
        slots:
          trackingId: path.trackingId
          geofenceId: path.geofenceId
      - text: Start watching tracker {trackingId} against geofence {geofenceId}.
        slots:
          trackingId: path.trackingId
          geofenceId: path.geofenceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/associations/v3/{trackingId}/geofences/{geofenceId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Detach a geofence from a device
      effect: destructive
      questions:
      - Can I stop geofence events for one device without deleting the geofence?
      - What unlinks a tracker from a geofence?
      instructions:
      - text: Disassociate device {trackingId} from geofence {geofenceId}.
        slots:
          trackingId: path.trackingId
          geofenceId: path.geofenceId
      - text: Stop watching tracker {trackingId} against geofence {geofenceId}.
        slots:
          trackingId: path.trackingId
          geofenceId: path.geofenceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/associations/v3/{trackingId}/rules/{ruleId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Attach a rule to a device
      effect: write
      questions:
      - How do I make a tracking rule generate events for a device?
      - Can I link one tracker to a single rule?
      instructions:
      - text: Associate device {trackingId} with rule {ruleId}.
        slots:
          trackingId: path.trackingId
          ruleId: path.ruleId
      - text: Apply rule {ruleId} to tracker {trackingId}.
        slots:
          ruleId: path.ruleId
          trackingId: path.trackingId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/associations/v3/{trackingId}/rules/{ruleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Detach a rule from a device
      effect: destructive
      questions:
      - Can I stop one rule from firing for a single device?
      - What removes a single rule association from a tracker?
      instructions:
      - text: Disassociate device {trackingId} from rule {ruleId}.
        slots:
          trackingId: path.trackingId
          ruleId: path.ruleId
      - text: Remove rule {ruleId} from tracker {trackingId}.
        slots:
          ruleId: path.ruleId
          trackingId: path.trackingId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/associations/v3/{trackingId}/sensors'].get
  update:
    x-apievangelist-phrasing:
      intent: List sensor rules on a device
      effect: read
      questions:
      - Which sensor rules are active on a given tracker?
      - What temperature or battery sensor rules apply to my device?
      instructions:
      - text: List the sensor rules associated with device {trackingId}.
        slots:
          trackingId: path.trackingId
      - text: Show tracker {trackingId}'s sensor rules.
        slots:
          trackingId: path.trackingId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/associations/v3/{trackingId}/geofences'].get
  update:
    x-apievangelist-phrasing:
      intent: List geofences on a device
      effect: read
      questions:
      - Which geofences is a particular device associated with?
      - Can I filter a device's associated geofences by geofence type?
      instructions:
      - text: List the geofences associated with device {trackingId}.
        slots:
          trackingId: path.trackingId
      - text: Show tracker {trackingId}'s geofences of type {type}.
        slots:
          trackingId: path.trackingId
          type: query.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/associations/v3/{trackingId}/rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List rules on a device
      effect: read
      questions:
      - Which rules are attached to a given tracker?
      - What rules will generate events for this device?
      instructions:
      - text: Find the tracking rules, not sensor rules, bound to {trackingId}.
        slots:
          trackingId: path.trackingId
      - text: Show tracker {trackingId}'s associated rules.
        slots:
          trackingId: path.trackingId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/associations/v3/devices/{trackingId}/batchCreate'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach several rules and geofences to a device
      effect: write
      questions:
      - Can I associate many rules and geofences with one device in a single call?
      - Is there a bulk way to link a tracker to rules and geofences?
      instructions:
      - text: Associate device {trackingId} with rules {ruleIds} and geofences {geofenceIds}.
        slots:
          trackingId: path.trackingId
          ruleIds: requestBody.ruleIds
          geofenceIds: requestBody.geofenceIds
      - text: Bulk-link tracker {trackingId} to rules {ruleIds} and geofences {geofenceIds}.
        slots:
          trackingId: path.trackingId
          ruleIds: requestBody.ruleIds
          geofenceIds: requestBody.geofenceIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/associations/v3/devices/{trackingId}/batchDelete'].post
  update:
    x-apievangelist-phrasing:
      intent: Detach several rules and geofences from a device
      effect: destructive
      questions:
      - Can I unlink many rules and geofences from one device at once?
      - Is there a bulk way to remove a tracker's rule and geofence associations?
      instructions:
      - text: Disassociate device {trackingId} from rules {ruleIds} and geofences {geofenceIds}.
        slots:
          trackingId: path.trackingId
          ruleIds: requestBody.ruleIds
          geofenceIds: requestBody.geofenceIds
      - text: Bulk-unlink tracker {trackingId} from rules {ruleIds} and geofences {geofenceIds}.
        slots:
          trackingId: path.trackingId
          ruleIds: requestBody.ruleIds
          geofenceIds: requestBody.geofenceIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/associations/v3/devices/batchUpdate'].put
  update:
    x-apievangelist-phrasing:
      intent: Swap rule associations across many devices
      effect: write
      questions:
      - Can I replace one set of rules with another on many devices at once?
      - What's the way to move a fleet of trackers from old rules to new ones?
      instructions:
      - text: On devices {trackingIds}, replace rules {oldRules} with {newRules}.
        slots:
          trackingIds: requestBody.trackingIds
          oldRules: requestBody.oldRules
          newRules: requestBody.newRules
      - text: Switch trackers {trackingIds} from rules {oldRules} to rules {newRules}.
        slots:
          trackingIds: requestBody.trackingIds
          oldRules: requestBody.oldRules
          newRules: requestBody.newRules
      method: generated
      generated: '2026-10-01'