HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Here Fuel stations API

8 actions 8 updates phrasing extends openapi/here-fuel-stations-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 8

$.info
$.paths['/fuel/stations'].get
$.paths['/fuel/stations/{id}'].get
$.paths['/stations'].get
$.paths['/stations'].post
$.paths['/stations/{id}'].get
$.paths['/stations/bulk'].get
$.paths['/stations/count'].get

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 Fuel stations API
  version: 1.0.0
extends: openapi/here-fuel-stations-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: 7
- target: $.paths['/fuel/stations'].get
  update:
    x-apievangelist-phrasing:
      intent: Find fuel stations with the v2 fuel search
      effect: read
      questions:
      - Where are the cheapest diesel stations near me using the older v2 fuel prices search?
      - Can the v2 fuel search look along a corridor with a set width in meters?
      - Does the v2 fuel station search let me filter by brand?
      instructions:
      - text: Find v2 fuel stations within {prox} selling fuel type {fueltype}.
        slots:
          prox: query.prox
          fueltype: query.fueltype
      - text: Search v2 fuel stations inside bounding box {bbox} sorted by {sortkey}.
        slots:
          bbox: query.bbox
          sortkey: query.sortkey
      - text: List v2 fuel stations along corridor {corridor} within {corridorwidth} meters.
        slots:
          corridor: query.corridor
          corridorwidth: query.corridorwidth
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fuel/stations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a fuel station's details (v2)
      effect: read
      questions:
      - How do I get prices and details for one station on the v2 fuel API?
      - What details does the legacy v2 station lookup return?
      instructions:
      - text: Get v2 details for fuel station {id}.
        slots:
          id: path.id
      - text: Show the v2 fuel prices at station {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/stations'].get
  update:
    x-apievangelist-phrasing:
      intent: Find fuel stations and prices in an area
      effect: read
      questions:
      - Where is the cheapest diesel within a few kilometres of me?
      - Can I limit nearby fuel stations to certain brands?
      - Which stations in an area sell a given fuel type, sorted by distance?
      instructions:
      - text: Find fuel stations in {in} sorted by {sort}.
        slots:
          in: query.in
          sort: query.sort
      - text: Find stations in {in} selling fuel type {fuelTypes} from brands {brands}.
        slots:
          in: query.in
          fuelTypes: query.fuelTypes
          brands: query.brands
      method: generated
      generated: '2026-10-01'
- target: $.paths['/stations'].post
  update:
    x-apievangelist-phrasing:
      intent: Find fuel stations along a route
      effect: read
      questions:
      - What fuel stations are along my planned route?
      - How wide a corridor around the route can I search for fuel?
      instructions:
      - text: Find fuel stations along route corridor {corridor} within {width} of the road.
        slots:
          corridor: requestBody.corridor
          width: requestBody.width
      - text: List stations selling {fuel_types} along corridor {corridor}, sorted by {sort}.
        slots:
          fuel_types: query.fuelTypes
          corridor: requestBody.corridor
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/stations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one fuel station's data
      effect: read
      questions:
      - What are the current prices at a specific fuel station?
      - Can I get a station's brand icon at a particular size?
      instructions:
      - text: Get the data for fuel station {id}.
        slots:
          id: path.id
      - text: Show fuel station {id} with a {icon_size} pixel brand icon.
        slots:
          id: path.id
          icon_size: query.iconSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/stations/bulk'].get
  update:
    x-apievangelist-phrasing:
      intent: Get several fuel stations by ID
      effect: read
      questions:
      - Can I fetch prices for a list of fuel stations in one call?
      - Is it possible to return only dynamic price data for multiple stations?
      instructions:
      - text: Get fuel stations {ids} in one request.
        slots:
          ids: query.ids
      - text: Fetch only {content} data for stations {ids}.
        slots:
          content: query.content
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/stations/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count fuel stations in an area
      effect: read
      questions:
      - How many fuel stations are there in a given area?
      - Can I get a station count without the station list?
      instructions:
      - text: Count the fuel stations in {area}.
        slots:
          area: query.in
      - text: Tell me the number of fuel stations within {area}.
        slots:
          area: query.in
      method: generated
      generated: '2026-09-26'