API Evangelist conversational phrasing for Map Attributes V8 API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Map Attributes V8 API
  version: 1.0.0
extends: openapi/here-map-attributes-v8-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: 23
- target: $.paths['/v8/maps/attributes'].get
  update:
    x-apievangelist-phrasing:
      intent: Search map content layers for geometries
      effect: read
      questions:
      - How can I pull HERE map content attributes for road links inside a bounding box?
      - Can I filter map layer geometries with a SQL-style expression when searching by proximity?
      - Which release quarter of map content does a layer search use if I don't specify one?
      instructions:
      - text: Search the {layers} map layers for geometries within {in} using a GET request.
        slots:
          layers: query.layers
          in: query.in
      - text: Get attributes {attributes} from layer {layers} for map release {release} with a simple GET query.
        slots:
          attributes: query.attributes
          layers: query.layers
          release: query.release
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v8/maps/attributes'].post
  update:
    x-apievangelist-phrasing:
      intent: Search map layers for geometries via POST
      effect: read
      questions:
      - Is there a POST version of the map layer search for when my spatial filter is too long for a URL?
      - Can I send a long corridor filter in a POST body to search map content layers?
      instructions:
      - text: Use the POST form of the layer search to find geometries in {layers} along corridor {in}.
        slots:
          layers: query.layers
          in: query.in
      - text: Post a layer search on {layers} with filter {filter}, returning up to {count} geometries.
        slots:
          layers: query.layers
          filter: query.filter
          count: query.count
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v8/maps/attributes/segments'].get
  update:
    x-apievangelist-phrasing:
      intent: Enrich separate road segments with map attributes
      effect: read
      questions:
      - How do I look up map attributes for a handful of unconnected road segments?
      - Can I enrich individual segment references with speed limits or other map content via a GET call?
      instructions:
      - text: Get attributes {attributes} for the unconnected segments {segmentRefs} with a GET request.
        slots:
          attributes: query.attributes
          segmentRefs: query.segmentRefs
      - text: Enrich a few individual segments {segmentRefs} with map content from {mapName}.
        slots:
          segmentRefs: query.segmentRefs
          mapName: query.mapName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v8/maps/attributes/segments'].post
  update:
    x-apievangelist-phrasing:
      intent: Enrich many road segments with attributes via POST
      effect: read
      questions:
      - What's the recommended way to enrich a large batch of segment references with map attributes?
      - Can I send segment refs in a POST body instead of the URL when looking up segment attributes?
      instructions:
      - text: Post the large list of segment references {segmentRefs} in the body and return attributes {attributes} for each.
        slots:
          segmentRefs: requestBody.segmentRefs
          attributes: query.attributes
      - text: Bulk-enrich segments {segmentRefs} with map content using the POST segments endpoint.
        slots:
          segmentRefs: requestBody.segmentRefs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v8/maps/upload'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload WKT or Shapefile geometries to a layer
      effect: write
      questions:
      - How do I import my own polygons or points in WKT format into a custom map layer?
      - Can I upload a Shapefile as a private geometry layer with the legacy upload endpoint?
      - Can I grant other app IDs access to a geometry layer when I upload it?
      instructions:
      - text: Upload the WKT file {file} as custom geometry layer {layerId}.
        slots:
          file: query.file
          layerId: query.layerId
      - text: Import geometries from {file} into layer {layerId} and grant access to apps {grantedAppIds}.
        slots:
          file: query.file
          layerId: query.layerId
          grantedAppIds: query.grantedAppIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v8/maps/modify'].post
  update:
    x-apievangelist-phrasing:
      intent: Modify geometries in an uploaded layer
      effect: write
      questions:
      - How do I append or replace geometries in a custom layer I already uploaded?
      - How long after modifying layer geometries do the changes become searchable?
      instructions:
      - text: Apply action {action} to layer {layerId} using the geometries in {file}.
        slots:
          action: query.action
          layerId: query.layerId
          file: query.file
      - text: Update the existing geometries of my uploaded layer {layerId} from file {file} with action {action}.
        slots:
          layerId: query.layerId
          file: query.file
          action: query.action
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v8/maps/routeisoline'].get
  update:
    x-apievangelist-phrasing:
      intent: Find POIs reachable within a detour of a route
      effect: read
      questions:
      - How can I find points of interest within a 10-minute detour along my driving route?
      - Can I limit route-side POI search by maximum detour distance for a truck with trailers?
      - Which POI layers can I search for places reachable from a route?
      instructions:
      - text: Find POIs in layers {layer_ids} reachable within {max_detour_time} seconds of the route through {waypoints}.
        slots:
          layer_ids: query.layer_ids
          max_detour_time: query.max_detour_time
          waypoints: query.waypoint0 ... waypointN
      - text: Search for places within {max_detour_distance} meters of detour along the route via {waypoints}.
        slots:
          max_detour_distance: query.max_detour_distance
          waypoints: query.waypoint0 ... waypointN
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v8/maps/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List map regions and releases as JSON
      effect: read
      questions:
      - Which map regions and releases are available to my app, in JSON?
      - Can I list only my private BYOD maps rather than the public HERE maps?
      instructions:
      - text: List the available maps of type {mapType} as JSON.
        slots:
          mapType: query.mapType
      - text: Return a JSON list of every map region and release my app can use.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v8/maps/list.html'].get
  update:
    x-apievangelist-phrasing:
      intent: List available maps as an HTML page
      effect: read
      questions:
      - Is there a human-readable HTML page showing all maps my app can access?
      - Can I browse the public and private map list in a browser instead of JSON?
      instructions:
      - text: Show the HTML page listing maps of type {mapType}.
        slots:
          mapType: query.mapType
      - text: Open the browsable HTML list of all maps available to my app.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v8/maps/layers/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List available map layers as JSON
      effect: read
      questions:
      - What map content layers can I query, returned as JSON?
      - Can I restrict the layer list to one region such as Postal Code Boundaries or WEU?
      instructions:
      - text: List the JSON catalog of layers in map region {mapName}.
        slots:
          mapName: query.mapName
      - text: Get the JSON list of layers of type {layerType}.
        slots:
          layerType: query.layerType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v8/maps/layers/list.html'].get
  update:
    x-apievangelist-phrasing:
      intent: List available map layers as an HTML page
      effect: read
      questions:
      - Can I see the available map layers on an HTML page I can read in a browser?
      - Is there a web view listing the layers for a particular map region?
      instructions:
      - text: Show the HTML page of layers for map {mapName}.
        slots:
          mapName: query.mapName
      - text: Open the HTML layer list filtered to layer type {layerType}.
        slots:
          layerType: query.layerType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v8/maps/layers/doc'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a layer's attribute documentation as JSON
      effect: read
      questions:
      - Where can I get the official attribute descriptions for one map layer in JSON?
      - What columns does a specific map content layer expose?
      instructions:
      - text: Get the JSON documentation for layer {layer}.
        slots:
          layer: query.layer
      - text: Return the attribute list and descriptions of layer {layer} in map {mapName} as JSON.
        slots:
          layer: query.layer
          mapName: query.mapName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v8/maps/layers/doc.html'].get
  update:
    x-apievangelist-phrasing:
      intent: View a layer's documentation as an HTML page
      effect: read
      questions:
      - Is there a readable HTML page documenting the attributes of a single layer?
      - Can I view one layer's attribute reference in my browser?
      instructions:
      - text: Open the HTML documentation page for layer {layer}.
        slots:
          layer: query.layer
      - text: Show layer {layer} of map {mapName} documented in HTML.
        slots:
          layer: query.layer
          mapName: query.mapName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v8/maps/layers/attributes'].get
  update:
    x-apievangelist-phrasing:
      intent: List attributes across all layers as JSON
      effect: read
      questions:
      - Which attributes exist across every map layer, as one JSON list?
      - Can I find which layer carries a given attribute column?
      instructions:
      - text: List all layer attributes across every layer in JSON.
      - text: Get the JSON attribute index across layers for map type {mapType}.
        slots:
          mapType: query.mapType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v8/maps/layers/attributes.html'].get
  update:
    x-apievangelist-phrasing:
      intent: View attributes across all layers as HTML
      effect: read
      questions:
      - Is there an HTML table of every attribute across all map layers?
      - Can I browse the cross-layer attribute list in a web page?
      instructions:
      - text: Open the HTML page listing attributes across all layers.
      - text: Show the cross-layer attribute table in HTML for map {mapName}.
        slots:
          mapName: query.mapName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v8/maps/indexes'].get
  update:
    x-apievangelist-phrasing:
      intent: List available layer indexes as JSON
      effect: read
      questions:
      - Which indexes are available on public and custom layers, in JSON?
      - What attributes are indexed so I can look up tiles by value?
      instructions:
      - text: List the available layer indexes as JSON.
      - text: Get the JSON index list for map {mapName}.
        slots:
          mapName: query.mapName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v8/maps/indexes.html'].get
  update:
    x-apievangelist-phrasing:
      intent: View available layer indexes as HTML
      effect: read
      questions:
      - Can I see the list of layer indexes on an HTML page?
      - Is there a browser-friendly view of custom and public layer indexes?
      instructions:
      - text: Open the HTML page of layer indexes.
      - text: Show layer indexes for map type {mapType} in HTML.
        slots:
          mapType: query.mapType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v8/maps/index'].get
  update:
    x-apievangelist-phrasing:
      intent: Find tile IDs containing an attribute value
      effect: read
      questions:
      - How do I find which tiles contain a particular attribute value in a map layer?
      - Does the tile lookup by value work on my custom uploaded layers?
      instructions:
      - text: Find tile IDs in layer {layer} where {attributes} equals {values}.
        slots:
          layer: query.layer
          attributes: query.attributes
          values: query.values
      - text: List the tiles of layer {layer} that contain value {values}.
        slots:
          layer: query.layer
          values: query.values
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v8/maps/delete'].get
  update:
    x-apievangelist-phrasing:
      intent: Delete uploaded geometry layers
      effect: destructive
      questions:
      - How do I delete custom geometry layers I uploaded to the map attributes service?
      - Can I remove a whole custom map or overlay rather than individual layers?
      instructions:
      - text: Delete my uploaded geometry layer {layerId}.
        slots:
          layerId: query.layerId
      - text: Remove layer {layerId} from storage {storage}.
        slots:
          layerId: query.layerId
          storage: query.storage
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v8/maps/content.html'].get
  update:
    x-apievangelist-phrasing:
      intent: Open the inline documentation landing page
      effect: read
      questions:
      - Where is the landing page for the map attributes inline documentation?
      - Can I get an HTML overview page of the service's built-in docs?
      instructions:
      - text: Open the inline documentation landing page for map attributes.
      - text: Show the HTML start page of the built-in map content docs.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v8/maps/serviceconfiguration'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the service's parameter limits
      effect: read
      questions:
      - What are the numeric limits on parameters like count or corridor width for this service?
      - Can the map attributes service limits get stricter in future releases?
      instructions:
      - text: Get the service configuration showing parameter boundary values.
      - text: Show me the current numeric limits for map attributes calls.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v8/maps/attributes/path'].get
  update:
    x-apievangelist-phrasing:
      intent: Get map attributes along a route path
      effect: read
      questions:
      - How can I enrich a continuous route with map attributes like speed limits along the way?
      - Can I pass a flexible polyline to get attributes along a truck route?
      instructions:
      - text: Get attributes {attributes} along the route path {flexiblePolyline} with a GET request.
        slots:
          attributes: query.attributes
          flexiblePolyline: query.flexiblePolyline
      - text: Enrich the continuous path of links {links} for transport mode {transportMode}.
        slots:
          links: query.links
          transportMode: query.transportMode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v8/maps/attributes/path'].post
  update:
    x-apievangelist-phrasing:
      intent: Get map attributes along a long route via POST
      effect: read
      questions:
      - What should I use to get attributes along a very long route path that won't fit in a URL?
      - Can I send a route's segments in a POST body to enrich the whole path?
      instructions:
      - text: Post the long route polyline {flexiblePolyline} in the body and return attributes {attributes} along it.
        slots:
          flexiblePolyline: requestBody.flexiblePolyline
          attributes: query.attributes
      - text: Enrich the continuous path made of segments {segments} using the POST path endpoint.
        slots:
          segments: requestBody.segments
      method: generated
      generated: '2026-09-26'