dotCMS · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for dotCMS REST Notifications API

6 actions 6 updates phrasing extends openapi/dotcms-notifications-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/api/v1/notification/delete'].put

$.paths['/api/v1/notification/id/{id}'].delete

$.paths['/api/v1/notification/getNewNotificationsCount'].get

$.paths['/api/v1/notification/getNotifications/{params}'].get

$.paths['/api/v1/notification/markAsRead'].put

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 dotCMS REST Notifications API
  version: 1.0.0
extends: openapi/dotcms-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: 5
- target: $.paths['/api/v1/notification/delete'].put
  update:
    x-apievangelist-phrasing:
      intent: Delete several notifications
      effect: destructive
      questions:
      - How do I clear a batch of notifications at once?
      - Can I delete multiple notifications by their IDs?
      instructions:
      - text: Delete notifications {items}.
        slots:
          items: requestBody.items
      - text: Clear the notifications listed in {items}.
        slots:
          items: requestBody.items
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/notification/id/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a notification
      effect: destructive
      questions:
      - How do I dismiss one notification permanently?
      - Can I remove a single notification by ID?
      instructions:
      - text: Delete notification {id}.
        slots:
          id: path.id
      - text: Dismiss notification {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/notification/getNewNotificationsCount'].get
  update:
    x-apievangelist-phrasing:
      intent: Count unread notifications
      effect: read
      questions:
      - How many new notifications do I have?
      - Is there anything unread in my notifications?
      instructions:
      - text: Count my new notifications using {params}.
        slots:
          params: path.params
      - text: Get the unread notification total with {params}.
        slots:
          params: path.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/notification/getNotifications/{params}'].get
  update:
    x-apievangelist-phrasing:
      intent: List notifications
      effect: read
      questions:
      - What notifications have I received?
      - Can I fetch notifications in a range for paging?
      instructions:
      - text: List my notifications with {params}.
        slots:
          params: path.params
      - text: Get notifications {params} for range {Range}.
        slots:
          params: path.params
          Range: header.Range
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/notification/markAsRead'].put
  update:
    x-apievangelist-phrasing:
      intent: Mark all notifications as read
      effect: write
      questions:
      - How do I mark my notifications as read?
      - Can I clear the unread badge on notifications?
      instructions:
      - text: Mark all my notifications as read.
      - text: Clear my unread notification count.
      method: generated
      generated: '2026-09-26'