HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for HERE Tracking Rules API

9 actions 9 updates phrasing extends openapi/here-rules-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['/rules/v4/health'].get

$.paths['/rules/v4/version'].get

$.paths['/rules/v4'].get

$.paths['/rules/v4'].post

$.paths['/rules/v4'].delete

$.paths['/rules/v4/{ruleId}'].get

$.paths['/rules/v4/{ruleId}'].put

$.paths['/rules/v4/{ruleId}'].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 Rules API
  version: 1.0.0
extends: openapi/here-rules-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['/rules/v4/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the Rules service health
      effect: read
      questions:
      - Is the HERE Tracking Rules service up right now?
      - Can I ping the Rules service before sending it requests?
      instructions:
      - text: Check the health of the Rules service.
      - text: Tell me whether the Rules service is healthy.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rules/v4/version'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Rules service version
      effect: read
      questions:
      - What version of the Rules service is deployed?
      - Which build of the Rules service am I talking to?
      instructions:
      - text: Get the version of the Rules service.
      - text: Show me which Rules service version is running.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rules/v4'].get
  update:
    x-apievangelist-phrasing:
      intent: List all tracking rules
      effect: read
      questions:
      - Which detention or dwelling rules are defined in my project?
      - Can I page through every rule in a project?
      instructions:
      - text: List all rules in project {projectId}.
        slots:
          projectId: query.projectId
      - text: Show {limit} rules per page.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rules/v4'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a tracking rule
      effect: write
      questions:
      - How do I set up a detention rule with a time threshold?
      - Does a new rule work before it is associated with a device?
      instructions:
      - text: Create a rule in project {projectId}.
        slots:
          projectId: query.projectId
      - text: Add a new detention rule to my project.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rules/v4'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete every rule in a project
      effect: destructive
      questions:
      - Can I remove all tracking rules at once?
      - What confirmation is needed to wipe every rule in a project?
      instructions:
      - text: Delete all rules in project {projectId} with x-confirm {confirm}.
        slots:
          projectId: query.projectId
          confirm: header.x-confirm
      - text: Remove every tracking rule, confirming with {confirm}.
        slots:
          confirm: header.x-confirm
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rules/v4/{ruleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one rule's definition
      effect: read
      questions:
      - What is the threshold of a specific rule?
      - Can I fetch a single rule by ID?
      instructions:
      - text: Get rule {ruleId}.
        slots:
          ruleId: path.ruleId
      - text: Show the definition of rule {ruleId}.
        slots:
          ruleId: path.ruleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rules/v4/{ruleId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a rule's name or threshold
      effect: write
      questions:
      - Can I change the threshold of an existing rule?
      - Is it possible to change a rule's type after creating it?
      instructions:
      - text: Update rule {ruleId} with a new threshold.
        slots:
          ruleId: path.ruleId
      - text: Rename rule {ruleId} and change its description.
        slots:
          ruleId: path.ruleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rules/v4/{ruleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one rule
      effect: destructive
      questions:
      - Can I delete a single rule and keep the others?
      - What removes one tracking rule by ID?
      instructions:
      - text: Delete rule {ruleId}.
        slots:
          ruleId: path.ruleId
      - text: Remove the single rule {ruleId}.
        slots:
          ruleId: path.ruleId
      method: generated
      generated: '2026-10-01'