HERE · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/here-discover-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['/discover'].get
$.paths['/discover'].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 Discover API
  version: 1.0.0
extends: openapi/here-discover-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['/discover'].get
  update:
    x-apievangelist-phrasing:
      intent: Search places and addresses by free text
      effect: read
      questions:
      - How do I search for a place by a free-form text query?
      - Can I find coffee shops by name ranked by relevance near a point?
      instructions:
      - text: Search for {q} near {at}.
        slots:
          q: query.q
          at: query.at
      - text: Find the top {limit} places matching {q} in {in}.
        slots:
          limit: query.limit
          q: query.q
          in: query.in
      method: generated
      generated: '2026-10-01'
- target: $.paths['/discover'].post
  update:
    x-apievangelist-phrasing:
      intent: Search places by text along a route (beta)
      effect: read
      questions:
      - Can I run a free-text place search along a route sent in the request body?
      - Is there a beta discover call that accepts a long route?
      instructions:
      - text: Discover places matching {q} along route {route}.
        slots:
          q: query.q
          route: requestBody.route
      - text: Use the beta POST discover for {q} with route {route}.
        slots:
          q: query.q
          route: requestBody.route
      method: generated
      generated: '2026-10-01'