HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Tour Planning API v3 Asynchronous API

6 actions 6 updates phrasing extends openapi/here-asynchronous-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 6

$.info

$.paths['/problems/async'].post

$.paths['/status/{statusId}'].get

$.paths['/problems/{problemId}/solution'].get

$.paths['/problems/{problemId}/cancel'].put

$.paths['/matrices'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Tour Planning API v3 Asynchronous API
  version: 1.0.0
extends: openapi/here-asynchronous-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: 5
- target: $.paths['/problems/async'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a vehicle routing problem to solve
      effect: write
      questions:
      - How do I optimize delivery routes for my fleet asynchronously?
      - Can I send jobs and vehicles and get optimized tours later?
      instructions:
      - text: Submit a routing problem with fleet {fleet} and plan {plan}.
        slots:
          fleet: requestBody.fleet
          plan: requestBody.plan
      - text: Optimize tours for fleet {fleet} over plan {plan} with objectives {objectives}.
        slots:
          fleet: requestBody.fleet
          plan: requestBody.plan
          objectives: requestBody.objectives
      method: generated
      generated: '2026-09-26'
- target: $.paths['/status/{statusId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an asynchronous tour planning request
      effect: read
      questions:
      - Is my submitted routing problem finished solving?
      - What is the status of my tour optimization request?
      instructions:
      - text: Check the status of request {status_id}.
        slots:
          status_id: path.statusId
      - text: Tell me whether tour planning job {status_id} is done.
        slots:
          status_id: path.statusId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/problems/{problemId}/solution'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the solution to a routing problem
      effect: read
      questions:
      - Where do I get the optimized tours after the solver finishes?
      - Can I fetch a solution using the problem ID?
      instructions:
      - text: Get the solution for problem {problem_id}.
        slots:
          problem_id: path.problemId
      - text: Download the optimized tours for routing problem {problem_id}.
        slots:
          problem_id: path.problemId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/problems/{problemId}/cancel'].put
  update:
    x-apievangelist-phrasing:
      intent: Cancel a submitted routing problem
      effect: destructive
      questions:
      - Can I stop the solver working on a problem I submitted?
      - What happens to solutions after I cancel a problem?
      instructions:
      - text: Cancel routing problem {problem_id}.
        slots:
          problem_id: path.problemId
      - text: Stop the solver on problem {problem_id}.
        slots:
          problem_id: path.problemId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/matrices'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a routing matrix for later problems
      effect: write
      questions:
      - Can I supply my own travel time and distance matrix for tour planning?
      - How do I reuse a custom routing matrix across async problems?
      instructions:
      - text: Upload a routing matrix with origins {origins}, distances {distances} and travel times {travelTimes}.
        slots:
          origins: requestBody.origins
          distances: requestBody.distances
          travelTimes: requestBody.travelTimes
      - text: Store my custom matrix for origins {origins} using travel times {travelTimes} and distances {distances}.
        slots:
          origins: requestBody.origins
          travelTimes: requestBody.travelTimes
          distances: requestBody.distances
      method: generated
      generated: '2026-10-01'