Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Multi-Tenant Notifications API

5 actions 5 updates phrasing extends openapi/palo-alto-networks-notifications-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Palo Alto Networks's API. It is a proposal applied on top of the contract, not a document Palo Alto Networks publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/api/cloud/2.0/agg/notifications/list'].post
$.paths['/api/cloud/2.0/agg/notifications/list/count'].post
$.paths['/api/cloud/2.0/agg/notifications/list/state'].post
$.paths['/api/cloud/2.0/agg/notifications/list/state/{notification-id}'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Multi-Tenant Notifications API
  version: 1.0.0
extends: openapi/palo-alto-networks-notifications-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: 4
- target: $.paths['/api/cloud/2.0/agg/notifications/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List notifications across child tenants
      effect: read
      questions:
      - Which upgrade and announcement notifications have my child tenants received?
      - Can I see only unread notifications, newest first?
      instructions:
      - text: List notifications for my child tenants matching filters {filters}.
        slots:
          filters: requestBody.filters
      - text: Show notifications sorted by {sortByList}, page {page}.
        slots:
          sortByList: requestBody.sortByList
          page: requestBody.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cloud/2.0/agg/notifications/list/count'].post
  update:
    x-apievangelist-phrasing:
      intent: Count notifications
      effect: read
      questions:
      - How many unread notifications do I have?
      - What's the total number of upgrade notifications across my tenants?
      instructions:
      - text: Count my notifications matching filters {filters}.
        slots:
          filters: requestBody.filters
      - text: Tell me how many unread notifications I have.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cloud/2.0/agg/notifications/list/state'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark notifications read or unread
      effect: write
      questions:
      - How do I mark a batch of notifications as read?
      - Can I flip notifications back to unread?
      instructions:
      - text: Mark notifications {notifIds} as {readState}.
        slots:
          notifIds: requestBody.notifIds
          readState: requestBody.readState
      - text: Set notifications {notifIds} to read.
        slots:
          notifIds: requestBody.notifIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cloud/2.0/agg/notifications/list/state/{notification-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether a notification is read
      effect: read
      questions:
      - Have I already read a particular notification?
      - Can I check the read state of one notification?
      instructions:
      - text: Get the read state of notification {notification-id} under profile {notification-profile-id}.
        slots:
          notification-id: path.notification-id
          notification-profile-id: path.notification-profile-id
      - text: Check whether notification {notification-id} for profile {notification-profile-id} is marked read.
        slots:
          notification-id: path.notification-id
          notification-profile-id: path.notification-profile-id
      method: generated
      generated: '2026-10-01'