HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for HERE Route Matching V8 API

4 actions 4 updates phrasing extends openapi/here-route-matching-v8-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 4

$.info
$.paths['/v8/match/routelinks'].get
$.paths['/v8/match/routelinks'].post
$.paths['/v8/maps/overlays/upload'].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 HERE Route Matching V8 API
  version: 1.0.0
extends: openapi/here-route-matching-v8-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/v8/match/routelinks'].get
  update:
    x-apievangelist-phrasing:
      intent: Match a short GPS trace to roads via query string
      effect: read
      questions:
      - How can I snap a handful of GPS waypoints to the road network with a simple GET?
      - Is a GET with the waypoints in the query string enough to match a short GPS trace?
      instructions:
      - text: Match waypoints {waypointN} to the most probable {mode} route using a GET request.
        slots:
          waypointN: query.waypointN
          mode: query.mode
      - text: Snap the query-string trace {waypointN} to roads for a {mode}, avoiding areas {avoidAreas}.
        slots:
          waypointN: query.waypointN
          mode: query.mode
          avoidAreas: query.avoidAreas
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v8/match/routelinks'].post
  update:
    x-apievangelist-phrasing:
      intent: Match an uploaded GPS trace to the driven path
      effect: read
      questions:
      - How do I match a large GPS trace file to the path a truck actually drove?
      - Can route matching reconstruct the journey's coordinates and report toll costs?
      - Which vehicle types does GPS trace matching support?
      instructions:
      - text: Match the GPS trace in the request body to the driven {mode} route.
        slots:
          mode: query.mode
      - text: Post this trace for {mode} route matching and return path coordinates {pathCoordinates}.
        slots:
          mode: query.mode
          pathCoordinates: query.pathCoordinates
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v8/maps/overlays/upload'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a custom overlay map for route matching
      effect: write
      questions:
      - Can I block or add road links privately so route matching uses my changes?
      - Are overlay map edits visible to other customers?
      instructions:
      - text: Upload overlay map changes {overlay_spec} for route matching.
        slots:
          overlay_spec: query.overlay_spec
      - text: Submit overlay {overlay_spec} as map {mapName} using the deprecated overlay upload.
        slots:
          overlay_spec: query.overlay_spec
          mapName: query.mapName
      method: generated
      generated: '2026-09-26'