HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Authentication API v1.1 Manage Device Accounts API

7 actions 7 updates phrasing extends openapi/here-manage-device-accounts-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 7

$.info

$.paths['/devices'].get

$.paths['/devices'].delete

$.paths['/devices/{device}'].get

$.paths['/devices/{device}'].delete

$.paths['/devices/{device}'].patch

$.paths['/projects/{project}/devices'].get

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 Authentication API v1.1 Manage Device Accounts API
  version: 1.0.0
extends: openapi/here-manage-device-accounts-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/devices'].get
  update:
    x-apievangelist-phrasing:
      intent: List device accounts in a realm
      effect: read
      questions:
      - Which devices are registered in my HERE realm?
      - Can I find a device by its identity provider and external ID?
      instructions:
      - text: List all devices in realm {realm}.
        slots:
          realm: query.realm
      - text: Find devices from identity provider {identityProvider} with external ID {externalId}.
        slots:
          identityProvider: query.identityProvider
          externalId: query.externalId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a device by identity provider and external ID
      effect: destructive
      questions:
      - How do I delete a device when I only know its external ID?
      - Can I delete several devices in one request?
      instructions:
      - text: Delete the device with external ID {externalId} from identity provider {identityProvider}.
        slots:
          externalId: query.externalId
          identityProvider: query.identityProvider
      - text: Remove device {externalId} registered through {identityProvider}.
        slots:
          externalId: query.externalId
          identityProvider: query.identityProvider
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{device}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a device by HRN
      effect: read
      questions:
      - What are the details of a device account given its HRN?
      - Is a specific device still enabled?
      instructions:
      - text: Get device {device}.
        slots:
          device: path.device
      - text: Show whether device {device} is enabled.
        slots:
          device: path.device
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{device}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a device by HRN
      effect: destructive
      questions:
      - How do I delete a device account using its HRN?
      - Can I permanently remove a decommissioned device?
      instructions:
      - text: Delete device {device} by its HRN.
        slots:
          device: path.device
      - text: Permanently remove decommissioned device {device}.
        slots:
          device: path.device
      method: generated
      generated: '2026-09-26'
- target: $.paths['/devices/{device}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Enable or disable a device
      effect: write
      questions:
      - Can I disable a device without deleting it?
      - How do I turn a disabled device back on?
      instructions:
      - text: Set device {device} enabled to {enabled}.
        slots:
          device: path.device
          enabled: requestBody.enabled
      - text: Disable device {device}.
        slots:
          device: path.device
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project}/devices'].get
  update:
    x-apievangelist-phrasing:
      intent: List devices in a project
      effect: read
      questions:
      - Which devices belong to a specific project?
      - Can I filter a project's devices by identity provider?
      instructions:
      - text: List devices in project {project}.
        slots:
          project: path.project
      - text: Show devices in project {project} from identity provider {identityProvider}.
        slots:
          project: path.project
          identityProvider: query.identityProvider
      method: generated
      generated: '2026-09-26'