HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Geocoding and Search API v7 Autosuggest API

3 actions 3 updates phrasing extends openapi/here-autosuggest-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['/autosuggest'].get
$.paths['/autosuggest'].post

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 Geocoding and Search API v7 Autosuggest API
  version: 1.0.0
extends: openapi/here-autosuggest-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: 2
- target: $.paths['/autosuggest'].get
  update:
    x-apievangelist-phrasing:
      intent: Suggest places as a user types
      effect: read
      questions:
      - How do I show address suggestions while someone is typing?
      - Can autosuggest handle a misspelled or half-typed place name?
      - Which query term completions can I get near a given location?
      instructions:
      - text: Suggest places for the partial query {q} near {at}.
        slots:
          q: query.q
          at: query.at
      - text: Give me up to {limit} completions for {q} in {lang}.
        slots:
          limit: query.limit
          q: query.q
          lang: query.lang
      method: generated
      generated: '2026-10-01'
- target: $.paths['/autosuggest'].post
  update:
    x-apievangelist-phrasing:
      intent: Suggest places along a route (beta)
      effect: read
      questions:
      - Can I get typing suggestions for places along a long route polyline?
      - Is there a beta autosuggest that accepts the route in the request body?
      instructions:
      - text: Suggest places matching {q} along route {route} sent in the body.
        slots:
          q: query.q
          route: requestBody.route
      - text: Use the beta POST autosuggest for {q} with route {route}.
        slots:
          q: query.q
          route: requestBody.route
      method: generated
      generated: '2026-10-01'