# 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 Registry API version: 1.0.0 extends: openapi/here-registry-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['/registry/v2/health'].get update: x-apievangelist-phrasing: intent: Check the Registry service health effect: read questions: - Is the HERE Tracking Registry service up right now? - Can I ping the Registry service before sending it requests? instructions: - text: Check the health of the Registry service. - text: Tell me whether the Registry service is healthy. method: generated generated: '2026-10-01' - target: $.paths['/registry/v2/version'].get update: x-apievangelist-phrasing: intent: Get the Registry service version effect: read questions: - What version of the Registry service is deployed? - Which build of the Registry service am I talking to? instructions: - text: Get the version of the Registry service. - text: Show me which Registry service version is running. method: generated generated: '2026-10-01' - target: $.paths['/registry/v2/{appId}/devices'].get update: x-apievangelist-phrasing: intent: List devices provisioned under an app effect: read questions: - Which device licenses have I provisioned for a project app? - Can I page through every device a user project provisioned? instructions: - text: List devices provisioned by app {appId}. slots: appId: path.appId - text: Show {count} provisioned devices per page for app {appId}. slots: count: query.count appId: path.appId method: generated generated: '2026-10-01' - target: $.paths['/registry/v2/{appId}/devices'].post update: x-apievangelist-phrasing: intent: Provision licenses for many devices in a batch job effect: write questions: - How do I create device licenses for a whole fleet at once? - Can I bulk-provision virtual devices and auto-claim them? instructions: - text: Start a batch job creating device licenses for app {appId}. slots: appId: path.appId - text: Bulk-provision devices for app {appId} with autoclaim {autoclaim}. slots: appId: path.appId autoclaim: query.autoclaim method: generated generated: '2026-10-01' - target: $.paths['/registry/v2/{appId}/one-device'].post update: x-apievangelist-phrasing: intent: Provision a license for one physical device effect: write questions: - How do I get a device ID and secret for a single tracker? - Can I create one device license and claim it right away? instructions: - text: Create a single device license for app {appId}. slots: appId: path.appId - text: Provision one physical device for {appId} and set autoclaim to {autoclaim}. slots: appId: path.appId autoclaim: query.autoclaim method: generated generated: '2026-10-01' - target: $.paths['/registry/v2/{appId}/licenseCount'].get update: x-apievangelist-phrasing: intent: Count device licenses provisioned under an app effect: read questions: - How many device licenses has my project provisioned? - What is my current device license count? instructions: - text: Get the device license count for app {appId}. slots: appId: path.appId - text: Tell me how many licenses app {appId} has provisioned. slots: appId: path.appId method: generated generated: '2026-10-01' - target: $.paths['/registry/v2/{jobId}/status'].get update: x-apievangelist-phrasing: intent: Check a bulk device license job's progress effect: read questions: - Is my bulk device provisioning job finished yet? - What is the progress of a multiple-device license request? instructions: - text: Check the status of license job {jobId}. slots: jobId: path.jobId - text: Show progress of bulk provisioning job {jobId}. slots: jobId: path.jobId method: generated generated: '2026-10-01' - target: $.paths['/registry/v2/{jobId}/results'].get update: x-apievangelist-phrasing: intent: Get the licenses a bulk job created effect: read questions: - Where do I get the device credentials a batch license job produced? - Can I page through the results of a finished provisioning job? instructions: - text: Get the results of license job {jobId}. slots: jobId: path.jobId - text: List the device credentials created by job {jobId}. slots: jobId: path.jobId method: generated generated: '2026-10-01' - target: $.paths['/registry/v2/devices/{deviceOrExternalId}'].get update: x-apievangelist-phrasing: intent: Find the tracking ID for a device ID effect: read questions: - What tracking ID was assigned to a claimed device? - If I know a device's deviceId, can I get its trackingId? instructions: - text: Get the tracking ID for device {deviceOrExternalId}. slots: deviceOrExternalId: path.deviceOrExternalId - text: Look up which trackingId device {deviceOrExternalId} has. slots: deviceOrExternalId: path.deviceOrExternalId method: generated generated: '2026-10-01' - target: $.paths['/registry/v2/devices/{deviceOrExternalId}'].put update: x-apievangelist-phrasing: intent: Claim a device for a user project effect: write questions: - How do I claim a tracker so it can start sending data? - Can I claim a device into a specific project? instructions: - text: Claim device {deviceOrExternalId}. slots: deviceOrExternalId: path.deviceOrExternalId - text: Claim device {deviceOrExternalId} into project {projectId}. slots: deviceOrExternalId: path.deviceOrExternalId projectId: query.projectId method: generated generated: '2026-10-01' - target: $.paths['/registry/v2/devices/{deviceOrExternalId}'].delete update: x-apievangelist-phrasing: intent: Deactivate a device license permanently effect: destructive questions: - How do I permanently deactivate a provisioned device license? - Does a device need to be unclaimed before deactivation? instructions: - text: Deactivate device license {deviceOrExternalId}. slots: deviceOrExternalId: path.deviceOrExternalId - text: Permanently retire device {deviceOrExternalId} so it can't be claimed. slots: deviceOrExternalId: path.deviceOrExternalId method: generated generated: '2026-10-01' - target: $.paths['/registry/v2/{trackingId}'].get update: x-apievangelist-phrasing: intent: Find the device ID for a tracking ID effect: read questions: - Which deviceId belongs to a given tracking ID? - Can I reverse a trackingId back to the physical device ID? instructions: - text: Get the deviceId for tracking ID {trackingId}. slots: trackingId: path.trackingId - text: Look up the physical device behind tracker {trackingId}. slots: trackingId: path.trackingId method: generated generated: '2026-10-01' - target: $.paths['/registry/v2/{trackingId}'].delete update: x-apievangelist-phrasing: intent: Unclaim a device effect: destructive questions: - How do I release a device so someone else can claim it? - What happens to my data access when I unclaim a tracker? instructions: - text: Unclaim device {trackingId}. slots: trackingId: path.trackingId - text: Remove my ownership of tracker {trackingId}. slots: trackingId: path.trackingId method: generated generated: '2026-10-01' - target: $.paths['/registry/v2/licenses'].get update: x-apievangelist-phrasing: intent: List my projects and their licenses effect: read questions: - Which tracking projects am I a member of, and what licenses do they have? - Can I filter my project license list by project type? instructions: - text: List my projects with their license details. - text: Show license info for projects {projectIds}. slots: projectIds: query.projectIds method: generated generated: '2026-10-01' - target: $.paths['/registry/v2/features'].get update: x-apievangelist-phrasing: intent: Get a project's enabled features effect: read questions: - What features are turned on for my tracking project? - Can I see a project's feature configuration? instructions: - text: Get the features of project {projectId}. slots: projectId: query.projectId - text: Show which features project {projectId} has enabled. slots: projectId: query.projectId method: generated generated: '2026-10-01' - target: $.paths['/registry/v2/features'].patch update: x-apievangelist-phrasing: intent: Update a project's features effect: write questions: - How do I change feature settings on a tracking project? - Do feature properties I leave out keep their existing values? instructions: - text: Update features of project {projectId} with {data}. slots: projectId: query.projectId data: requestBody.data - text: Patch project feature settings to {data}. slots: data: requestBody.data method: generated generated: '2026-10-01' - target: $.paths['/registry/v4/resources/{resourceType}/find'].post update: x-apievangelist-phrasing: intent: Find resources of a type with filters effect: read questions: - Can I search all resources of one type using filters? - Which devices in my project match a set of filters? instructions: - text: Find {resourceType} resources matching filters {filters}. slots: resourceType: path.resourceType filters: requestBody.filters - text: Search {resourceType} in project {projectId} with {filters}. slots: resourceType: path.resourceType projectId: query.projectId filters: requestBody.filters method: generated generated: '2026-10-01'