HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for HERE Map Image API v3 Images API

3 actions 3 updates phrasing extends openapi/here-images-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['/{resource}/{projection}/{view}/{size}/{format}'].get

$.paths['/{resource}/{projection}/{view}/{size}/{format}'].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 HERE Map Image API v3 Images API
  version: 1.0.0
extends: openapi/here-images-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['/{resource}/{projection}/{view}/{size}/{format}'].get
  update:
    x-apievangelist-phrasing:
      intent: Render a static map image
      effect: read
      questions:
      - How do I get a static map picture of an area at a given size and format?
      - Can I add a scale bar or change the map style on a static map image?
      - Can I draw a small GeoJSON overlay on a static map using query parameters?
      instructions:
      - text: Render a {size} {format} map image of {view} using {resource} in projection {projection}.
        slots:
          size: path.size
          format: path.format
          view: path.view
          resource: path.resource
          projection: path.projection
      - text: Get a static {resource} map of {view} at {size} as {format} in {projection} with style {style}.
        slots:
          resource: path.resource
          view: path.view
          size: path.size
          format: path.format
          projection: path.projection
          style: query.style
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{resource}/{projection}/{view}/{size}/{format}'].post
  update:
    x-apievangelist-phrasing:
      intent: Render a map image with a large overlay via POST
      effect: read
      questions:
      - What if my overlay or GeoJSON is too large to fit in the static map URL?
      - Can I send route geometry in the request body to draw it on a map image?
      instructions:
      - text: Post my GeoJSON in the body and render a {size} {format} {resource} image of {view} in {projection}.
        slots:
          size: path.size
          format: path.format
          resource: path.resource
          view: path.view
          projection: path.projection
      - text: Draw the body-supplied overlay on a {format} map of {view}, size {size}, {resource} in {projection}.
        slots:
          format: path.format
          view: path.view
          size: path.size
          resource: path.resource
          projection: path.projection
      method: generated
      generated: '2026-09-26'