Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SSPM Management Plugin API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-plugin-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 6

$.info

$.paths['/sspm/api/v1/plugin-users'].get

$.paths['/sspm/api/v1/plugin-users/{id}/plugins'].get

$.paths['/sspm/api/v1/plugins'].get

$.paths['/sspm/api/v1/plugins/{id}'].get

$.paths['/sspm/api/v1/plugins/classification-aggregates'].get

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 SSPM Management Plugin API
  version: 1.0.0
extends: openapi/palo-alto-networks-plugin-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['/sspm/api/v1/plugin-users'].get
  update:
    x-apievangelist-phrasing:
      intent: List third-party plugin users
      effect: read
      questions:
      - Which users in my SaaS apps have installed third-party plugins?
      - Can I filter and sort the list of plugin users?
      instructions:
      - text: List third-party plugin users for tenant {tenant}.
        slots:
          tenant: header.x-ps-tenant
      - text: List plugin users in tenant {tenant} matching {filter}, ordered by {order_by}.
        slots:
          tenant: header.x-ps-tenant
          filter: query.filter
          order_by: query.order_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sspm/api/v1/plugin-users/{id}/plugins'].get
  update:
    x-apievangelist-phrasing:
      intent: List plugins a user has installed
      effect: read
      questions:
      - What third-party plugins has a specific user installed?
      - Can I see the plugins tied to one plugin user?
      instructions:
      - text: List the plugins installed by user {id} in tenant {tenant}.
        slots:
          id: path.id
          tenant: header.x-ps-tenant
      - text: Show third-party plugins for plugin user {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sspm/api/v1/plugins'].get
  update:
    x-apievangelist-phrasing:
      intent: List third-party plugins
      effect: read
      questions:
      - Which third-party plugins are present across my SaaS apps?
      - Can I filter the plugin inventory and sort it?
      instructions:
      - text: List all third-party plugins for tenant {tenant}.
        slots:
          tenant: header.x-ps-tenant
      - text: List third-party plugins in tenant {tenant} matching {filter}.
        slots:
          tenant: header.x-ps-tenant
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sspm/api/v1/plugins/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details on a plugin
      effect: read
      questions:
      - What do we know about a specific third-party plugin?
      - Can I pull full details for one plugin by ID?
      instructions:
      - text: Get details for plugin {id} in tenant {tenant}.
        slots:
          id: path.id
          tenant: header.x-ps-tenant
      - text: Show plugin {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sspm/api/v1/plugins/classification-aggregates'].get
  update:
    x-apievangelist-phrasing:
      intent: Summarize plugins by classification status
      effect: read
      questions:
      - How many plugins fall into each classification status?
      - Is there an aggregate summary of third-party plugin information?
      instructions:
      - text: Summarize plugin classification status for tenant {tenant}.
        slots:
          tenant: header.x-ps-tenant
      - text: Give me the aggregate plugin counts for tenant {tenant}.
        slots:
          tenant: header.x-ps-tenant
      method: generated
      generated: '2026-09-26'