HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for HERE Batch API v7 Batch notifications (BETA) API

7 actions 7 updates phrasing extends openapi/here-batch-notifications-beta-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 7

$.info

$.paths['/batch/notifications'].get

$.paths['/batch/notifications'].post

$.paths['/batch/notifications/{notificationId}'].get

$.paths['/batch/notifications/{notificationId}'].put

$.paths['/batch/notifications/{notificationId}'].delete

$.paths['/batch/notifications/{notificationId}/test'].get

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 Batch API v7 Batch notifications (BETA) API
  version: 1.0.0
extends: openapi/here-batch-notifications-beta-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: 6
- target: $.paths['/batch/notifications'].get
  update:
    x-apievangelist-phrasing:
      intent: List batch job notifications
      effect: read
      questions:
      - Which batch job notifications have I configured?
      - What notification endpoints can my client see for batch jobs?
      instructions:
      - text: List all my batch notifications.
      - text: Show every batch job notification my client can access.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/batch/notifications'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a batch job notification
      effect: write
      questions:
      - How do I get a webhook call when a batch job finishes?
      - What configuration does each notification type require?
      instructions:
      - text: Create a {type} notification {id} with config {config}.
        slots:
          type: requestBody.type
          id: requestBody.id
          config: requestBody.config
      - text: Set up a new webHook notification {id} for my batch jobs using config {config}.
        slots:
          id: requestBody.id
          config: requestBody.config
      method: generated
      generated: '2026-09-26'
- target: $.paths['/batch/notifications/{notificationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a batch job notification
      effect: read
      questions:
      - What is configured on one of my batch notifications?
      - When was a particular notification last used?
      instructions:
      - text: Show batch notification {notificationId}.
        slots:
          notificationId: path.notificationId
      - text: Get the configuration of notification {notificationId}.
        slots:
          notificationId: path.notificationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/batch/notifications/{notificationId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a batch job notification
      effect: write
      questions:
      - How do I change the webhook URL on an existing batch notification?
      - Can I switch an existing notification to a different type?
      instructions:
      - text: Replace notification {notificationId} with type {type} and config {config}.
        slots:
          notificationId: path.notificationId
          type: requestBody.type
          config: requestBody.config
      - text: Overwrite the config of existing notification {notificationId} with {config}.
        slots:
          notificationId: path.notificationId
          config: requestBody.config
      method: generated
      generated: '2026-09-26'
- target: $.paths['/batch/notifications/{notificationId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a batch job notification
      effect: destructive
      questions:
      - How do I stop getting notified about batch jobs on an endpoint?
      - Can I delete a notification I no longer use?
      instructions:
      - text: Delete batch notification {notificationId}.
        slots:
          notificationId: path.notificationId
      - text: Remove notification {notificationId}.
        slots:
          notificationId: path.notificationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/batch/notifications/{notificationId}/test'].get
  update:
    x-apievangelist-phrasing:
      intent: Send a test batch notification
      effect: read
      questions:
      - Can I check that my notification endpoint works without running a batch job?
      - Is there a way to fire a notification with dummy parameters?
      instructions:
      - text: Send a test to notification {notificationId}.
        slots:
          notificationId: path.notificationId
      - text: Fire notification {notificationId} with dummy data to test my endpoint.
        slots:
          notificationId: path.notificationId
      method: generated
      generated: '2026-09-26'