HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for HERE Geocoding & Search API v7 Batch Jobs Notifications API

3 actions 3 updates phrasing extends openapi/here-notifications-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['/notifications'].get

$.paths['/notifications'].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 Geocoding & Search API v7 Batch Jobs Notifications API
  version: 1.0.0
extends: openapi/here-notifications-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['/notifications'].get
  update:
    x-apievangelist-phrasing:
      intent: List notification subscriptions
      effect: read
      questions:
      - Which notification subscriptions do I currently have?
      - Can I see all my existing notifications in one list?
      instructions:
      - text: List my notification subscriptions.
      - text: Show every notification I'm subscribed to.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe to a notification event
      effect: write
      questions:
      - How do I get notified when a particular event happens?
      - Can I choose where a new notification subscription is delivered?
      instructions:
      - text: Create a notification subscription for event {event} sent to {target}.
        slots:
          event: requestBody.event
          target: requestBody.target
      - text: Subscribe {target} to {event} notifications.
        slots:
          target: requestBody.target
          event: requestBody.event
      method: generated
      generated: '2026-09-26'