Leadping · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Leadping Notifications API

9 actions 9 updates phrasing extends openapi/leadping-notifications-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Leadping's API. It is a proposal applied on top of the contract, not a document Leadping publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 9

$.info

$.paths['/notifications/{id}'].get

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

$.paths['/notifications/unread-count'].get

$.paths['/notifications/{id}/mark-read'].post

$.paths['/notifications/mark-all-read'].post

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

$.paths['/notifications/push/installations/current'].put

$.paths['/notifications/push/installations/{installationId}'].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 Leadping Notifications API
  version: 1.0.0
extends: openapi/leadping-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: 8
- target: $.paths['/notifications/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a notification
      effect: read
      questions:
      - How do I open one notification and see its content?
      - Has a specific notification been read yet?
      instructions:
      - text: Show notification {id}.
        slots:
          id: path.id
      - text: Get the details of notification {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/me'].post
  update:
    x-apievangelist-phrasing:
      intent: List my notifications
      effect: read
      questions:
      - What alerts and updates have I received?
      - Can I list notifications from a certain date range?
      instructions:
      - text: List my notifications.
      - text: Show my notifications between {startAt} and {endAt}.
        slots:
          startAt: query.startAt
          endAt: query.endAt
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/unread-count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count unread notifications
      effect: read
      questions:
      - How many unread notifications do I have?
      - What number should my notification badge show?
      instructions:
      - text: Get my unread notification count.
      - text: Tell me how many notifications I haven't read.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/{id}/mark-read'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark a notification as read
      effect: write
      questions:
      - How do I mark one notification as read?
      - Can I dismiss a single alert from my unread count?
      instructions:
      - text: Mark notification {id} as read.
        slots:
          id: path.id
      - text: Dismiss notification {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/mark-all-read'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark all notifications as read
      effect: write
      questions:
      - Is there a way to clear every unread notification at once?
      - How many notifications get updated when I mark them all read?
      instructions:
      - text: Mark all my notifications as read.
      - text: Clear my entire notification inbox.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/announcements'].post
  update:
    x-apievangelist-phrasing:
      intent: List announcements
      effect: read
      questions:
      - Where can I see Leadping release notes and notices?
      - What operational announcements have been posted for me?
      instructions:
      - text: List my announcements.
      - text: Search announcements for {search}.
        slots:
          search: requestBody.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/push/installations/current'].put
  update:
    x-apievangelist-phrasing:
      intent: Register a device for push notifications
      effect: write
      questions:
      - How do I get push notifications on my phone?
      - Can I refresh my mobile push registration after updating the app?
      instructions:
      - text: Register push installation {installationId} on platform {platform}.
        slots:
          installationId: requestBody.installationId
          platform: requestBody.platform
      - text: Refresh my device's push registration with channel {pushChannel}.
        slots:
          pushChannel: requestBody.pushChannel
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/push/installations/{installationId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Stop push notifications to a device
      effect: destructive
      questions:
      - How do I stop getting push notifications on an old phone?
      - Can I remove a device from my push notification list?
      instructions:
      - text: Unregister push installation {installationId}.
        slots:
          installationId: path.installationId
      - text: Stop sending push alerts to device installation {installationId}.
        slots:
          installationId: path.installationId
      method: generated
      generated: '2026-09-26'