Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Multi-Tenant Notifications Notification Profiles API

9 actions 9 updates phrasing extends openapi/palo-alto-networks-notification-profiles-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 9

$.info
$.paths['/api/cloud/2.0/agg/notifications/profiles'].get
$.paths['/api/cloud/2.0/agg/notifications/profiles'].post
$.paths['/api/cloud/2.0/agg/notifications/profiles/{notification-profile-id}'].get
$.paths['/api/cloud/2.0/agg/notifications/profiles/{notification-profile-id}'].delete
$.paths['/api/cloud/2.0/agg/notifications/profiles/opstate'].put
$.paths['/api/cloud/2.0/agg/notifications/profiles/types'].get
$.paths['/api/cloud/2.0/agg/notifications/profiles/webhook/test'].post
$.paths['/api/cloud/2.0/agg/notifications/profiles/retryOp'].post

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 Notification Profiles API
  version: 1.0.0
extends: openapi/palo-alto-networks-notification-profiles-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: 8
- target: $.paths['/api/cloud/2.0/agg/notifications/profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List multi-tenant notification profiles
      effect: read
      questions:
      - Which notification profiles are set up for my tenant?
      - What multi-tenant notification profiles do we already have?
      instructions:
      - text: List all notification profiles for my tenant.
      - text: Show every multi-tenant notification profile we have configured.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cloud/2.0/agg/notifications/profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a notification profile
      effect: write
      questions:
      - How do I set up a notification profile that alerts on child tenant upgrades?
      - Is a new notification profile active as soon as I create it?
      instructions:
      - text: Create notification profile {profileName} for tenants {tenantList} sending {notifTypeDetails} to channels {notifChannels}.
        slots:
          profileName: requestBody.profileName
          tenantList: requestBody.tenantList
          notifTypeDetails: requestBody.notifTypeDetails
          notifChannels: requestBody.notifChannels
      - text: Add profile {profileName} with status {status} and op state {opState} covering tenants {tenantList}, types {notifTypeDetails}, channels {notifChannels}.
        slots:
          profileName: requestBody.profileName
          status: requestBody.status
          opState: requestBody.opState
          tenantList: requestBody.tenantList
          notifTypeDetails: requestBody.notifTypeDetails
          notifChannels: requestBody.notifChannels
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cloud/2.0/agg/notifications/profiles/{notification-profile-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a notification profile
      effect: read
      questions:
      - What tenants and channels does one notification profile cover?
      - Can I look up a single notification profile by its ID?
      instructions:
      - text: Get notification profile {notification-profile-id}.
        slots:
          notification-profile-id: path.notification-profile-id
      - text: Show the inputs and output channels of notification profile {notification-profile-id}.
        slots:
          notification-profile-id: path.notification-profile-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cloud/2.0/agg/notifications/profiles/{notification-profile-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a notification profile
      effect: destructive
      questions:
      - How do I permanently remove a notification profile?
      - Can I delete a multi-tenant notification profile we no longer need?
      instructions:
      - text: Delete notification profile {notification-profile-id}.
        slots:
          notification-profile-id: path.notification-profile-id
      - text: Remove the unused notification profile {notification-profile-id} for good.
        slots:
          notification-profile-id: path.notification-profile-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cloud/2.0/agg/notifications/profiles/opstate'].put
  update:
    x-apievangelist-phrasing:
      intent: Enable or disable a notification profile
      effect: write
      questions:
      - How do I turn on a notification profile so it starts sending alerts?
      - Can I pause a notification profile without deleting it?
      instructions:
      - text: Set notification profile {profileId} to op state {opState}.
        slots:
          profileId: requestBody.profileId
          opState: requestBody.opState
      - text: Enable notification profile {profileId}.
        slots:
          profileId: requestBody.profileId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cloud/2.0/agg/notifications/profiles/types'].get
  update:
    x-apievangelist-phrasing:
      intent: List notification types and categories
      effect: read
      questions:
      - What notification types and categories can a profile subscribe to?
      - Which sub-categories exist under each notification category?
      instructions:
      - text: List the valid notification types, categories and sub-categories.
      - text: Show me which notification categories I can pick for a profile.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cloud/2.0/agg/notifications/profiles/webhook/test'].post
  update:
    x-apievangelist-phrasing:
      intent: Test a notification webhook
      effect: read
      questions:
      - Can the notification service reach my webhook URL before I use it in a profile?
      - How do I verify a webhook's auth token works for notifications?
      instructions:
      - text: Test webhook connectivity to {urls} using {authType} auth with token {token}.
        slots:
          urls: requestBody.urls
          authType: requestBody.authType
          token: requestBody.token
      - text: Check that the notification service can reach webhook {urls} with {authType} token {token}.
        slots:
          urls: requestBody.urls
          authType: requestBody.authType
          token: requestBody.token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cloud/2.0/agg/notifications/profiles/retryOp'].post
  update:
    x-apievangelist-phrasing:
      intent: Retry pushing an incident profile to tenants
      effect: write
      questions:
      - What can I do when an incident profile failed to push to some child tenants?
      - Can I retry an incident profile push for just a few tenants?
      instructions:
      - text: Retry pushing incident profile {profileId} to child tenants {tenantList}.
        slots:
          profileId: requestBody.profileId
          tenantList: requestBody.tenantList
      - text: Re-push incident profile {profileId} to the tenants where it failed.
        slots:
          profileId: requestBody.profileId
      method: generated
      generated: '2026-10-01'