Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Palo Alto Networks Catalog API

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

$.info
$.paths['/sspm/identity/v1/catalog/{appType}'].get
$.paths['/sspm/api/v1/catalog/apps'].get
$.paths['/sspm/api/v1/catalog/apps/{app}'].get
$.paths['/sspm/api/v1/catalog/apps/{app}/configs'].get
$.paths['/sspm/api/v1/catalog/apps/{app}/scopes'].get
$.paths['/sspm/api/v1/catalog/controls/{common_control_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 Palo Alto Networks Catalog API
  version: 1.0.0
extends: openapi/palo-alto-networks-catalog-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: 6
- target: $.paths['/sspm/identity/v1/catalog/{appType}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get identity catalog for an app type
      effect: read
      questions:
      - Which identity features does SSPM support for a given application type?
      - Can I check whether one SaaS app type supports a specific identity feature?
      instructions:
      - text: Show the SSPM identity catalog for app type {appType}.
        slots:
          appType: path.appType
      - text: Check whether app type {appType} supports identity feature {feature}.
        slots:
          appType: path.appType
          feature: query.feature
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sspm/api/v1/catalog/apps'].get
  update:
    x-apievangelist-phrasing:
      intent: List SSPM-supported SaaS applications
      effect: read
      questions:
      - Which SaaS applications can SaaS Security Posture Management monitor?
      - Is my SaaS app on the list of apps SSPM supports?
      instructions:
      - text: List every application SSPM supports.
      - text: Show the full catalog of SaaS apps available for posture management.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sspm/api/v1/catalog/apps/{app}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get catalog settings for an SSPM app
      effect: read
      questions:
      - What catalog settings does SSPM hold for one application?
      - Can I read the posture catalog entry for a specific SaaS app?
      instructions:
      - text: Show the SSPM catalog settings for app {app}.
        slots:
          app: path.app
      - text: Get the catalog entry for SaaS application {app}.
        slots:
          app: path.app
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sspm/api/v1/catalog/apps/{app}/configs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an app's catalog configuration settings
      effect: read
      questions:
      - Which configuration settings does SSPM check for a given SaaS app?
      - What posture configurations are defined in the catalog for one application?
      instructions:
      - text: List catalog configuration settings for app {app}.
        slots:
          app: path.app
      - text: Show which configs SSPM evaluates on {app}.
        slots:
          app: path.app
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sspm/api/v1/catalog/apps/{app}/scopes'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an app's plugin scope catalog
      effect: read
      questions:
      - What plugin scopes does SSPM need to connect to a SaaS app?
      - Which permissions scopes are listed for an application's plugin?
      instructions:
      - text: Show the plugin scope catalog for app {app}.
        slots:
          app: path.app
      - text: List the plugin scopes required to onboard {app}.
        slots:
          app: path.app
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sspm/api/v1/catalog/controls/{common_control_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Map a common control to compliance profiles
      effect: read
      questions:
      - Which compliance frameworks does a given common control map to?
      - Can I see the compliance profile mappings for one SSPM control ID?
      instructions:
      - text: Show compliance profile mappings for common control {common_control_id}.
        slots:
          common_control_id: path.common_control_id
      - text: List the compliance frameworks that control {common_control_id} maps to.
        slots:
          common_control_id: path.common_control_id
      method: generated
      generated: '2026-09-26'