HERE · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/here-browse-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['/browse'].get
$.paths['/browse'].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 Browse API
  version: 1.0.0
extends: openapi/here-browse-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['/browse'].get
  update:
    x-apievangelist-phrasing:
      intent: Browse nearby places by category or name
      effect: read
      questions:
      - What restaurants or shops are closest to a given point?
      - Can I browse places near me filtered by category or chain?
      instructions:
      - text: Browse places in categories {categories} near {at}.
        slots:
          categories: query.categories
          at: query.at
      - text: List places named {name} closest to {at}.
        slots:
          name: query.name
          at: query.at
      method: generated
      generated: '2026-10-01'
- target: $.paths['/browse'].post
  update:
    x-apievangelist-phrasing:
      intent: Browse places along a route (beta)
      effect: read
      questions:
      - Can I browse places by category along a long route passed in the body?
      - Is there a beta browse request that takes a route polyline?
      instructions:
      - text: Browse places in categories {categories} near {at} along route {route}.
        slots:
          categories: query.categories
          at: query.at
          route: requestBody.route
      - text: Use the beta POST browse around {at} with route {route}.
        slots:
          at: query.at
          route: requestBody.route
      method: generated
      generated: '2026-10-01'