HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Lookup Service v1 Platform API

3 actions 3 updates phrasing extends openapi/here-platform-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 3

$.info
$.paths['/platform/apis'].get
$.paths['/platform/apis/{api}/{version}'].get

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 Lookup Service v1 Platform API
  version: 1.0.0
extends: openapi/here-platform-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: 2
- target: $.paths['/platform/apis'].get
  update:
    x-apievangelist-phrasing:
      intent: List the HERE platform APIs
      effect: read
      questions:
      - Which platform APIs are available and where are their base URLs?
      - How long can I cache the list of platform API endpoints?
      instructions:
      - text: List all platform APIs.
      - text: Show me every platform API and its endpoint.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/apis/{api}/{version}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one platform API version
      effect: read
      questions:
      - What is the base URL for a specific platform API version?
      - Can I look up details for one API by name and version?
      instructions:
      - text: Get details for platform API {api} version {version}.
        slots:
          api: path.api
          version: path.version
      - text: Look up the endpoint of {api} {version}.
        slots:
          api: path.api
          version: path.version
      method: generated
      generated: '2026-09-26'