HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Notification API v2 API

4 actions 4 updates phrasing extends openapi/here-notification-api-v2-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 4

$.info

$.paths['/subscriptions'].post

$.paths['/layers/{notificationStreamLayerId}'].get

$.paths['/layers/{notificationStreamLayerId}'].delete

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 Notification API v2 API
  version: 1.0.0
extends: openapi/here-notification-api-v2-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/subscriptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe to catalog change notifications
      effect: write
      questions:
      - How do I get notified when a catalog changes?
      - Can catalog change notifications be delivered to my own stream layer?
      instructions:
      - text: Subscribe to change notifications for catalog {catalogHrn}.
        slots:
          catalogHrn: requestBody.notificationCatalogHRN
      - text: Send catalog {catalogHrn} change notifications to stream layer {streamLayerId}.
        slots:
          catalogHrn: requestBody.notificationCatalogHRN
          streamLayerId: requestBody.notificationStreamLayerId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/layers/{notificationStreamLayerId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List notification subscriptions for a layer
      effect: read
      questions:
      - Which catalog change subscriptions feed a given notification layer?
      - Can I see all subscriptions targeting my stream layer?
      instructions:
      - text: List subscriptions for notification layer {layer_id}.
        slots:
          layer_id: path.notificationStreamLayerId
      - text: Show every catalog change subscription that targets layer {layer_id}.
        slots:
          layer_id: path.notificationStreamLayerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/layers/{notificationStreamLayerId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete notification subscriptions for a layer
      effect: destructive
      questions:
      - Can I delete just some catalog change subscriptions by ID?
      - Is there a way to remove every subscription on a notification layer?
      instructions:
      - text: Delete subscriptions {subscription_ids} on notification layer {layer_id}.
        slots:
          subscription_ids: requestBody.subscriptionIds
          layer_id: path.notificationStreamLayerId
      - text: Remove all subscriptions on layer {layer_id} with delete all set to {delete_all}.
        slots:
          layer_id: path.notificationStreamLayerId
          delete_all: requestBody.deleteAll
      method: generated
      generated: '2026-09-26'