HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for HERE Tracking Sensors API

9 actions 9 updates phrasing extends openapi/here-sensors-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 9

$.info
$.paths['/sensors/v3/health'].get
$.paths['/sensors/v3/version'].get
$.paths['/sensors/v3'].get
$.paths['/sensors/v3'].post
$.paths['/sensors/v3'].delete
$.paths['/sensors/v3/{sensorRuleId}'].get
$.paths['/sensors/v3/{sensorRuleId}'].put
$.paths['/sensors/v3/{sensorRuleId}'].delete

OpenAPI Overlay

Raw ↑
# 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 Sensors API
  version: 1.0.0
extends: openapi/here-sensors-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['/sensors/v3/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the Sensors service health
      effect: read
      questions:
      - Is the HERE Tracking Sensors service up right now?
      - Can I ping the Sensors service before sending it requests?
      instructions:
      - text: Check the health of the Sensors service.
      - text: Tell me whether the Sensors service is healthy.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sensors/v3/version'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Sensors service version
      effect: read
      questions:
      - What version of the Sensors service is deployed?
      - Which build of the Sensors service am I talking to?
      instructions:
      - text: Get the version of the Sensors service.
      - text: Show me which Sensors service version is running.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sensors/v3'].get
  update:
    x-apievangelist-phrasing:
      intent: List all sensor rules
      effect: read
      questions:
      - Which temperature, humidity or battery sensor rules exist in my project?
      - Can I page through every sensor rule?
      instructions:
      - text: List all sensor rules in project {projectId}.
        slots:
          projectId: query.projectId
      - text: Show {count} sensor rules per page.
        slots:
          count: query.count
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sensors/v3'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a sensor rule
      effect: write
      questions:
      - How do I alert when a tracker's temperature leaves a range?
      - Can I create a battery level sensor rule?
      instructions:
      - text: Create a sensor rule in project {projectId}.
        slots:
          projectId: query.projectId
      - text: Add a new temperature range sensor rule to my project.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sensors/v3'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete every sensor rule in a project
      effect: destructive
      questions:
      - Can I wipe all sensor rules from a project at once?
      - What confirmation is needed to delete all sensor rules?
      instructions:
      - text: Delete all sensor rules in project {projectId} with x-confirm {confirm}.
        slots:
          projectId: query.projectId
          confirm: header.x-confirm
      - text: Remove every sensor rule, confirming with {confirm}.
        slots:
          confirm: header.x-confirm
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sensors/v3/{sensorRuleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one sensor rule
      effect: read
      questions:
      - What range or threshold does a specific sensor rule use?
      - Can I fetch a single sensor rule by ID?
      instructions:
      - text: Get sensor rule {sensorRuleId}.
        slots:
          sensorRuleId: path.sensorRuleId
      - text: Show the range of sensor rule {sensorRuleId}.
        slots:
          sensorRuleId: path.sensorRuleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sensors/v3/{sensorRuleId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a sensor rule's range or threshold
      effect: write
      questions:
      - Can I change the temperature range of an existing sensor rule?
      - Will unspecified sensor rule fields be reset to null on update?
      instructions:
      - text: Update sensor rule {sensorRuleId} with a new range.
        slots:
          sensorRuleId: path.sensorRuleId
      - text: Change the threshold and name of sensor rule {sensorRuleId}.
        slots:
          sensorRuleId: path.sensorRuleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sensors/v3/{sensorRuleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one sensor rule
      effect: destructive
      questions:
      - Can I delete a single sensor rule?
      - What removes one sensor rule by ID?
      instructions:
      - text: Delete sensor rule {sensorRuleId}.
        slots:
          sensorRuleId: path.sensorRuleId
      - text: Remove the single sensor rule {sensorRuleId}.
        slots:
          sensorRuleId: path.sensorRuleId
      method: generated
      generated: '2026-10-01'