HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Waypoints Sequence API

3 actions 3 updates phrasing extends openapi/here-waypoints-sequence-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['/v8/findsequence2'].get
$.paths['/v8/findsequence2'].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 Waypoints Sequence API
  version: 1.0.0
extends: openapi/here-waypoints-sequence-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: 2
- target: $.paths['/v8/findsequence2'].get
  update:
    x-apievangelist-phrasing:
      intent: Find the best order to visit waypoints
      effect: read
      questions:
      - What is the fastest order to visit a list of delivery stops?
      - Can waypoint sequencing account for truck height and hazardous goods?
      instructions:
      - text: Find the best sequence from {start} through {destinations} using mode {mode}.
        slots:
          start: query.start
          destinations: query.destination0...destinationN
          mode: query.mode
      - text: Order stops {destinations} starting at {start} and ending at {end} by {improve_for}.
        slots:
          destinations: query.destination0...destinationN
          start: query.start
          end: query.end
          improve_for: query.improveFor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v8/findsequence2'].post
  update:
    x-apievangelist-phrasing:
      intent: Sequence many waypoints with a form-encoded POST
      effect: read
      questions:
      - How do I sequence a large number of waypoints that won't fit in a URL?
      - Can I send waypoints in a form body instead of the query string?
      instructions:
      - text: Post waypoints {destinations} from {start} as a form body and sequence them using mode {mode}.
        slots:
          destinations: requestBody.destination0...destinationN
          start: requestBody.start
          mode: query.mode
      - text: Send a large stop list {destinations} ending at {end} in the request body for sequencing.
        slots:
          destinations: requestBody.destination0...destinationN
          end: requestBody.end
      method: generated
      generated: '2026-09-26'