HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Interactive Map API v1 Manage Tags API

6 actions 6 updates phrasing extends openapi/here-manage-tags-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['/layers/{layerId}/tags'].get

$.paths['/layers/{layerId}/tags'].post

$.paths['/layers/{layerId}/tags/{tagId}'].get

$.paths['/layers/{layerId}/tags/{tagId}'].delete

$.paths['/layers/{layerId}/tags/{tagId}'].patch

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 Interactive Map API v1 Manage Tags API
  version: 1.0.0
extends: openapi/here-manage-tags-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: 5
- target: $.paths['/layers/{layerId}/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List version tags on a map layer
      effect: read
      questions:
      - Which version tags exist on my interactive map layer?
      - Can the tag list include system tags too?
      instructions:
      - text: List the tags on layer {layerId}.
        slots:
          layerId: path.layerId
      - text: Show every version tag defined for {layerId}.
        slots:
          layerId: path.layerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/layers/{layerId}/tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Tag a version of a map layer
      effect: write
      questions:
      - How do I bookmark a specific version of a layer with a tag?
      - What version does a new tag point to if I don't give one?
      instructions:
      - text: Create tag {id} on layer {layerId} pointing at version {version}.
        slots:
          id: requestBody.id
          layerId: path.layerId
          version: requestBody.version
      - text: Tag the current HEAD of layer {layerId} as {id}.
        slots:
          layerId: path.layerId
          id: requestBody.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/layers/{layerId}/tags/{tagId}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a layer version tag
      effect: read
      questions:
      - Which layer version does a particular tag reference?
      - Who created a given tag and when?
      instructions:
      - text: Show tag {tagId} on layer {layerId}.
        slots:
          tagId: path.tagId
          layerId: path.layerId
      - text: Tell me what version tag {tagId} of {layerId} points to.
        slots:
          tagId: path.tagId
          layerId: path.layerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/layers/{layerId}/tags/{tagId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a layer version tag
      effect: destructive
      questions:
      - How do I remove a tag from a map layer?
      - Can I delete a version tag I no longer need?
      instructions:
      - text: Delete tag {tagId} from layer {layerId}.
        slots:
          tagId: path.tagId
          layerId: path.layerId
      - text: Remove the {tagId} tag on {layerId}.
        slots:
          tagId: path.tagId
          layerId: path.layerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/layers/{layerId}/tags/{tagId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Move a tag to another layer version
      effect: write
      questions:
      - How do I point an existing tag at a newer version of the layer?
      - Can I change which version a tag references after creating it?
      instructions:
      - text: Move tag {tagId} on layer {layerId} to version {version}.
        slots:
          tagId: path.tagId
          layerId: path.layerId
          version: requestBody.version
      - text: Repoint existing tag {tagId} of {layerId} at version {version}.
        slots:
          tagId: path.tagId
          layerId: path.layerId
          version: requestBody.version
      method: generated
      generated: '2026-09-26'