Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Palo Alto Networks Apps API

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

$.info

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

$.paths['/sspm/api/v1/apps/{app_id}'].get

$.paths['/sspm/api/v1/apps/{app_id}/configs'].get

$.paths['/sspm/api/v1/apps/{app_id}/settings'].get

$.paths['/v1/apps'].get

$.paths['/v1/apps'].post

$.paths['/v1/apps/{app_id}'].delete

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 Palo Alto Networks Apps API
  version: 1.0.0
extends: openapi/palo-alto-networks-apps-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: 7
- target: $.paths['/sspm/api/v1/apps'].get
  update:
    x-apievangelist-phrasing:
      intent: List registered SaaS apps in SSPM (sspm path)
      effect: read
      questions:
      - Which SaaS applications are registered in SSPM for my region?
      - Can I page through registered SaaS apps with a filter and sort order?
      instructions:
      - text: List registered SSPM applications in region {x-panw-region}.
        slots:
          x-panw-region: header.x-panw-region
      - text: Show registered SaaS apps matching filter {filter}, ordered by {order_by}.
        slots:
          filter: query.filter
          order_by: query.order_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sspm/api/v1/apps/{app_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a registered SaaS app's basic details
      effect: read
      questions:
      - What are the basic details of one onboarded SaaS application in SSPM?
      - How do I look up a registered application by its app ID?
      instructions:
      - text: Show details for SaaS app {app_id}.
        slots:
          app_id: path.app_id
      - text: Get the basic info of registered application {app_id} in region {x-panw-region}.
        slots:
          app_id: path.app_id
          x-panw-region: header.x-panw-region
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sspm/api/v1/apps/{app_id}/configs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a SaaS app's configuration details
      effect: read
      questions:
      - How is a particular SaaS application configured in SSPM?
      - Can I see the configuration items SSPM tracks for one app?
      instructions:
      - text: Show the configuration details of SaaS app {app_id}.
        slots:
          app_id: path.app_id
      - text: Pull the configs SSPM collected for app {app_id}.
        slots:
          app_id: path.app_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sspm/api/v1/apps/{app_id}/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a SaaS app's settings
      effect: read
      questions:
      - What settings does SSPM report for a given SaaS application?
      - Can I review the security settings of one onboarded app?
      instructions:
      - text: Show the settings of SaaS app {app_id}.
        slots:
          app_id: path.app_id
      - text: Get application settings for {app_id} in region {x-panw-region}.
        slots:
          app_id: path.app_id
          x-panw-region: header.x-panw-region
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/apps'].get
  update:
    x-apievangelist-phrasing:
      intent: List onboarded SaaS apps with posture counts
      effect: read
      questions:
      - Which SaaS apps are onboarded for posture assessment and how many failing checks does each have?
      - Can I list only onboarded apps with a certain connection status?
      instructions:
      - text: List onboarded SaaS apps with their posture check counts.
      - text: Show onboarded apps with connection status {status}, {limit} at a time.
        slots:
          status: query.status
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/apps'].post
  update:
    x-apievangelist-phrasing:
      intent: Onboard a SaaS app for posture assessment
      effect: write
      questions:
      - How do I connect a new SaaS application to SSPM for posture scanning?
      - What credentials does SSPM need when onboarding an app?
      instructions:
      - text: Onboard a {app_type} application to SSPM.
        slots:
          app_type: requestBody.app_type
      - text: Onboard {app_type} as {display_name} using credentials {credentials}.
        slots:
          app_type: requestBody.app_type
          display_name: requestBody.display_name
          credentials: requestBody.credentials
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/apps/{app_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an onboarded SaaS app from SSPM
      effect: destructive
      questions:
      - How do I stop SSPM from scanning a SaaS app and delete its results?
      - Is removing an onboarded application reversible?
      instructions:
      - text: Remove onboarded app {app_id} from SSPM.
        slots:
          app_id: path.app_id
      - text: Stop posture scanning and delete results for SaaS app {app_id}.
        slots:
          app_id: path.app_id
      method: generated
      generated: '2026-09-26'