Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Palo Alto Networks Assets API

8 actions 8 updates phrasing extends openapi/palo-alto-networks-assets-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['/assets/get_assets_internet_exposure'].post
$.paths['/assets/get_asset_internet_exposure'].post
$.paths['/assets/list_assets'].post
$.paths['/v1/assets'].get
$.paths['/v1/assets/id'].get
$.paths['/api/assets'].get
$.paths['/api/assets/{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 Assets API
  version: 1.0.0
extends: openapi/palo-alto-networks-assets-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['/assets/get_assets_internet_exposure'].post
  update:
    x-apievangelist-phrasing:
      intent: List internet-exposed assets found by Xpanse
      effect: read
      questions:
      - Which of our servers and cloud instances are visible from the internet according to Xpanse?
      - Can I filter internet-exposed assets by business unit or tag?
      instructions:
      - text: List all internet-exposed assets Xpanse has discovered.
      - text: Inventory externally visible assets using Xpanse filters {request_data}.
        slots:
          request_data: requestBody.request_data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/assets/get_asset_internet_exposure'].post
  update:
    x-apievangelist-phrasing:
      intent: Get details of one internet-exposed asset
      effect: read
      questions:
      - What services, certificates and observations does Xpanse show for one exposed asset?
      - Can I see the business context attached to a single internet-facing asset?
      instructions:
      - text: Get Xpanse exposure details for the asset in {request_data}.
        slots:
          request_data: requestBody.request_data
      - text: Show certificates and services of the internet-exposed asset identified by {request_data}.
        slots:
          request_data: requestBody.request_data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/assets/list_assets'].post
  update:
    x-apievangelist-phrasing:
      intent: List assets tracked by XSIAM
      effect: read
      questions:
      - What devices, users and service accounts has XSIAM observed in my environment?
      - Can I filter XSIAM assets by operating system or risk score?
      instructions:
      - text: List the assets XSIAM is tracking.
      - text: List XSIAM assets matching filter {request_data}.
        slots:
          request_data: requestBody.request_data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/assets'].get
  update:
    x-apievangelist-phrasing:
      intent: List DSPM cloud data assets with filters
      effect: read
      questions:
      - Which data stores in my cloud are open to the world according to DSPM?
      - Can I list DSPM assets that have more than a certain number of open risks?
      - What data assets were first detected after a given date in one region?
      instructions:
      - text: List DSPM assets in region {region} on cloud provider {cloudProvider}.
        slots:
          region: query.region.equals
          cloudProvider: query.cloudProvider.equals
      - text: Show DSPM assets with open-to-world set to {openToWorld} using API key {key}.
        slots:
          openToWorld: query.openToWorld.equals
          key: header.dig-api-key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/assets/id'].get
  update:
    x-apievangelist-phrasing:
      intent: Describe a DSPM data asset
      effect: read
      questions:
      - What does DSPM know about one specific data asset?
      - Can I describe a single DSPM asset by its id?
      instructions:
      - text: Describe DSPM asset {id}.
        slots:
          id: query.id
      - text: Get DSPM details for asset {id} using API key {key}.
        slots:
          id: query.id
          key: header.dig-api-key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/assets'].get
  update:
    x-apievangelist-phrasing:
      intent: List files and content scanned in SaaS apps
      effect: read
      questions:
      - Which files and folders in our connected SaaS apps are shared publicly?
      - Can I list SaaS Security scanned assets for one application only?
      instructions:
      - text: List SaaS scanned assets in app {app_id} with exposure {exposure}.
        slots:
          app_id: query.app_id
          exposure: query.exposure
      - text: Show scanned SaaS assets of type {type}.
        slots:
          type: query.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/assets/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a scanned SaaS asset's exposure and violations
      effect: read
      questions:
      - Who has access to a particular file scanned by SaaS Security?
      - What DLP violations and scan history exist for one SaaS asset?
      instructions:
      - text: Show exposure, collaborators and DLP violations for SaaS asset {id}.
        slots:
          id: path.id
      - text: Get the scan history of SaaS asset {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'