HERE · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for HERE Tracking Geofences API
11 actions
11 updates
phrasing
extends
openapi/here-geofences-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.
What the actions change
x-apievangelist-phrasing
Targets 11
$.info
$.paths['/geofences/v2/health'].get
$.paths['/geofences/v2/version'].get
$.paths['/geofences/v2'].get
$.paths['/geofences/v2'].post
$.paths['/geofences/v2'].delete
$.paths['/geofences/v2/{geofenceId}'].get
$.paths['/geofences/v2/{geofenceId}'].put
$.paths['/geofences/v2/{geofenceId}'].delete
$.paths['/geofences/v2/{geofenceId}/poiTraining'].post
$.paths['/geofences/v2/trainingTest'].post
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 Geofences API
version: 1.0.0
extends: openapi/here-geofences-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: 10
- target: $.paths['/geofences/v2/health'].get
update:
x-apievangelist-phrasing:
intent: Check the Geofences service health
effect: read
questions:
- Is the HERE Tracking Geofences service up right now?
- Can I ping the Geofences service before sending it requests?
instructions:
- text: Check the health of the Geofences service.
- text: Tell me whether the Geofences service is healthy.
method: generated
generated: '2026-10-01'
- target: $.paths['/geofences/v2/version'].get
update:
x-apievangelist-phrasing:
intent: Get the Geofences service version
effect: read
questions:
- What version of the Geofences service is deployed?
- Which build of the Geofences service am I talking to?
instructions:
- text: Get the version of the Geofences service.
- text: Show me which Geofences service version is running.
method: generated
generated: '2026-10-01'
- target: $.paths['/geofences/v2'].get
update:
x-apievangelist-phrasing:
intent: List all geofences in a project
effect: read
questions:
- Which geofences have I defined in my tracking project?
- Can I list only the geofences inside a bounding box?
instructions:
- text: List all geofences in project {projectId}.
slots:
projectId: query.projectId
- text: List geofences of type {type} inside {bbox}.
slots:
type: query.type
bbox: query.bbox
method: generated
generated: '2026-10-01'
- target: $.paths['/geofences/v2'].post
update:
x-apievangelist-phrasing:
intent: Create a geofence
effect: write
questions:
- How do I draw a circular or polygon geofence?
- Can I create a geofence around a point of interest?
instructions:
- text: Create a geofence in project {projectId}.
slots:
projectId: query.projectId
- text: Add a new circle geofence to my project.
method: generated
generated: '2026-10-01'
- target: $.paths['/geofences/v2'].delete
update:
x-apievangelist-phrasing:
intent: Delete every geofence in a project
effect: destructive
questions:
- Can I wipe all geofences in a project at once?
- Does deleting all geofences also remove the stock rules tied to them?
instructions:
- text: Delete all geofences in project {projectId} with x-confirm {confirm}.
slots:
projectId: query.projectId
confirm: header.x-confirm
- text: Remove every geofence from my project, confirming with {confirm}.
slots:
confirm: header.x-confirm
method: generated
generated: '2026-10-01'
- target: $.paths['/geofences/v2/{geofenceId}'].get
update:
x-apievangelist-phrasing:
intent: Get one geofence's details
effect: read
questions:
- What is the shape and definition of a specific geofence?
- Can I fetch a single geofence by its ID?
instructions:
- text: Get geofence {geofenceId}.
slots:
geofenceId: path.geofenceId
- text: Show the definition of geofence {geofenceId}.
slots:
geofenceId: path.geofenceId
method: generated
generated: '2026-10-01'
- target: $.paths['/geofences/v2/{geofenceId}'].put
update:
x-apievangelist-phrasing:
intent: Replace a geofence's definition
effect: write
questions:
- Can I change an existing geofence's shape or name?
- Do I have to send every geofence property when updating one?
instructions:
- text: Update geofence {geofenceId} with a new definition.
slots:
geofenceId: path.geofenceId
- text: Replace geofence {geofenceId}, forcing the change with {force}.
slots:
geofenceId: path.geofenceId
force: query.force
method: generated
generated: '2026-10-01'
- target: $.paths['/geofences/v2/{geofenceId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete one geofence
effect: destructive
questions:
- Can I remove a single geofence and keep the others?
- What deletes one geofence by ID?
instructions:
- text: Delete geofence {geofenceId}.
slots:
geofenceId: path.geofenceId
- text: Remove the single geofence {geofenceId}.
slots:
geofenceId: path.geofenceId
method: generated
generated: '2026-10-01'
- target: $.paths['/geofences/v2/{geofenceId}/poiTraining'].post
update:
x-apievangelist-phrasing:
intent: Train a POI geofence from device telemetry
effect: write
questions:
- How do I define a POI geofence boundary from radio measurements?
- Can I train an indoor POI geofence using a device's ingested data?
instructions:
- text: Train POI geofence {geofenceId} from device telemetry.
slots:
geofenceId: path.geofenceId
- text: Run POI training on geofence {geofenceId}.
slots:
geofenceId: path.geofenceId
method: generated
generated: '2026-10-01'
- target: $.paths['/geofences/v2/trainingTest'].post
update:
x-apievangelist-phrasing:
intent: Test whether POI geofence training will work
effect: read
questions:
- Can I check if a POI geofence can be trained before actually training it?
- Is my telemetry sample good enough to train a POI geofence?
instructions:
- text: Check whether a POI geofence training is possible with this data sample.
- text: Dry-run POI geofence training on this telemetry.
method: generated
generated: '2026-10-01'