Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Palo Alto Networks AIOps for NGFW BPA BPA Requests API

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

$.info

$.paths['/requests'].post

$.paths['/requests/{request_id}'].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 Palo Alto Networks AIOps for NGFW BPA BPA Requests API
  version: 1.0.0
extends: openapi/palo-alto-networks-bpa-requests-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: 2
- target: $.paths['/requests'].post
  update:
    x-apievangelist-phrasing:
      intent: Request a Best Practice Assessment for a firewall
      effect: write
      questions:
      - How do I run a Best Practice Assessment against one of my NGFW devices?
      - What details about the firewall do I need to submit a BPA request?
      instructions:
      - text: Submit a BPA request for firewall {serial_number} running PAN-OS {version}.
        slots:
          serial_number: requestBody.serial_number
          version: requestBody.version
      - text: Start a best practice assessment of device {serial_number} on version {version} with device info {device_info}.
        slots:
          serial_number: requestBody.serial_number
          version: requestBody.version
          device_info: requestBody.device_info
      method: generated
      generated: '2026-09-26'
- target: $.paths['/requests/{request_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of a BPA request
      effect: read
      questions:
      - Has my Best Practice Assessment finished processing yet?
      - Where do I get the report ID once a BPA request completes?
      - How long are BPA request records kept after completion?
      instructions:
      - text: Check the status of BPA request {request_id}.
        slots:
          request_id: path.request_id
      - text: Get the report ID for completed BPA request {request_id}.
        slots:
          request_id: path.request_id
      method: generated
      generated: '2026-09-26'