Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Palo Alto Networks Asset Explorer API

8 actions 8 updates phrasing extends openapi/palo-alto-networks-asset-explorer-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['/filter/resource/scan_info/suggest'].get
$.paths['/filter/resource/scan_info/suggest'].post
$.paths['/resource/scan_info'].get
$.paths['/resource/scan_info'].post
$.paths['/v2/resource/scan_info'].get
$.paths['/v2/resource/scan_info'].post
$.paths['/uai/v1/asset'].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 Palo Alto Networks Asset Explorer API
  version: 1.0.0
extends: openapi/palo-alto-networks-asset-explorer-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['/filter/resource/scan_info/suggest'].get
  update:
    x-apievangelist-phrasing:
      intent: List resource scan info filters
      effect: read
      questions:
      - What filters can I use when exploring resource scan results in the asset explorer?
      - Which resource info filter keys are supported, with their recent default options?
      instructions:
      - text: List the supported resource info filters and their default options.
      - text: Show me the asset explorer filter keys for resource scan info.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filter/resource/scan_info/suggest'].post
  update:
    x-apievangelist-phrasing:
      intent: Autocomplete values for a resource info filter
      effect: read
      questions:
      - What values are available for one resource info filter in the asset explorer?
      - Can I type part of a value and get matching suggestions for a resource scan filter?
      instructions:
      - text: Suggest values for resource info filter {filterName}.
        slots:
          filterName: requestBody.filterName
      - text: Autocomplete resource filter {filterName} for entries containing {query}.
        slots:
          filterName: requestBody.filterName
          query: requestBody.query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resource/scan_info'].get
  update:
    x-apievangelist-phrasing:
      intent: Get v1 resource scan pass/fail results
      effect: read
      questions:
      - Which of my cloud resources failed policy scans in a given time window, using the original scan info endpoint?
      - Can the legacy resource scan info call filter by vulnerability severity?
      instructions:
      - text: Get v1 resource scan info with time type {timeType}.
        slots:
          timeType: query.timeType
      - text: Show v1 resources with scan status {status} over the last {timeAmount} {timeUnit} ({timeType}).
        slots:
          status: query.scan.status
          timeAmount: query.timeAmount
          timeUnit: query.timeUnit
          timeType: query.timeType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resource/scan_info'].post
  update:
    x-apievangelist-phrasing:
      intent: Query v1 resource scan info by POST
      effect: read
      questions:
      - Is there a POST version of the older resource scan info call that takes filters and a time range in the body?
      - Can I group legacy resource scan results by cloud type?
      instructions:
      - text: POST a v1 resource scan info query with filters {filters} and time range {timeRange}.
        slots:
          filters: requestBody.filters
          timeRange: requestBody.timeRange
      - text: Get v1 resource scan results grouped by {groupBy} via POST.
        slots:
          groupBy: requestBody.groupBy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/resource/scan_info'].get
  update:
    x-apievangelist-phrasing:
      intent: Get V2 resource scan pass/fail results
      effect: read
      questions:
      - Which resources are currently failing policy checks according to the V2 scan info endpoint?
      - Can I filter V2 resource scan info by account group and policy severity?
      instructions:
      - text: Get V2 resource scan info for cloud account {account}.
        slots:
          account: query.cloud.account
      - text: Show V2 resources failing scans with policy severity {severity} in account group {group}.
        slots:
          severity: query.asset.severity
          group: query.account.group
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/resource/scan_info'].post
  update:
    x-apievangelist-phrasing:
      intent: Query V2 resource scan info by POST
      effect: read
      questions:
      - Can I send body filters and choose fields for the V2 resource scan info query?
      - Which V2 POST call returns resource-level pass/fail statistics?
      instructions:
      - text: POST a V2 resource scan info query with filters {filters}.
        slots:
          filters: requestBody.filters
      - text: Get V2 resource scan results returning only {fields}.
        slots:
          fields: requestBody.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uai/v1/asset'].post
  update:
    x-apievangelist-phrasing:
      intent: Get details for one unified asset
      effect: read
      questions:
      - How do I see the raw cloud provider JSON for a single asset by its RRN?
      - Can I look up an external finding on an asset with its risk factors?
      instructions:
      - text: Get asset {assetId} with query type {type}.
        slots:
          assetId: requestBody.assetId
          type: requestBody.type
      - text: Show the raw details of asset {assetId} ({type}) for finding type {findingType}.
        slots:
          assetId: requestBody.assetId
          type: requestBody.type
          findingType: requestBody.findingType
      method: generated
      generated: '2026-09-26'