HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Here API Information API

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

$.paths['/version'].get

$.paths['/isalive'].get

$.paths['/openapi'].get

$.paths['/fuel/isalive'].get

$.paths['/fuel/version'].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 Here API Information API
  version: 1.0.0
extends: openapi/here-api-information-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['/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check health of the cost management usage service
      effect: read
      questions:
      - Is the HERE cost management usage service up right now?
      - Can I ping the usage service before pulling billing data?
      instructions:
      - text: Check the health of the cost management usage service.
      - text: Ping the usage API to see if it is healthy.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/version'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the cost management usage API version
      effect: read
      questions:
      - Which version of the cost management usage API is deployed?
      - What release is the usage API currently running?
      instructions:
      - text: Get the version of the cost management usage API.
      - text: Show the usage service's API version information.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/isalive'].get
  update:
    x-apievangelist-phrasing:
      intent: Check that the weather service is alive
      effect: read
      questions:
      - Is the weather service working properly?
      - Can I run a liveness check against the weather API?
      instructions:
      - text: Check whether the weather service is alive.
      - text: Run the weather API liveness check.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/openapi'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the weather API specification
      effect: read
      questions:
      - Where can I get the OpenAPI definition for the weather API v3?
      - Does the weather service publish its own spec in YAML?
      instructions:
      - text: Download the weather API v3 OpenAPI specification.
      - text: Fetch the weather service's YAML spec.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fuel/isalive'].get
  update:
    x-apievangelist-phrasing:
      intent: Check that the fuel prices service is alive
      effect: read
      questions:
      - Is the fuel prices service responding?
      - Can I health-check the fuel API before querying prices?
      instructions:
      - text: Check whether the fuel prices service is alive.
      - text: Run a liveness check on the fuel API.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fuel/version'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the fuel prices service version
      effect: read
      questions:
      - What version of the fuel prices service is running?
      - Which fuel service release am I talking to?
      instructions:
      - text: Get the fuel prices service version.
      - text: Show which version the fuel API reports.
      method: generated
      generated: '2026-09-26'