Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Best Practice Assessment Report BPA Report API

4 actions 4 updates phrasing extends openapi/palo-alto-networks-bpa-report-api-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 4

$.info

$.paths['/bpa/v1/jobs/{id}'].get

$.paths['/bpa/v1/reports/{id}'].get

$.paths['/bpa/v1/requests'].post

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 Best Practice Assessment Report BPA Report API
  version: 1.0.0
extends: openapi/palo-alto-networks-bpa-report-api-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: 3
- target: $.paths['/bpa/v1/jobs/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a BPA report job status
      effect: read
      questions:
      - Has my Best Practice Assessment job finished processing?
      - What is the status of a BPA assessment job?
      instructions:
      - text: Get the status of BPA job {id}.
        slots:
          id: path.id
      - text: Check whether BPA assessment job {id} is complete.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bpa/v1/reports/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the download URL for a BPA report
      effect: read
      questions:
      - Where can I download a completed BPA report?
      - Does the BPA report link expire after it is issued?
      instructions:
      - text: Get the download URL for BPA report {id}.
        slots:
          id: path.id
      - text: Fetch the signed link to completed BPA report {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/bpa/v1/requests'].post
  update:
    x-apievangelist-phrasing:
      intent: Request a Best Practice Assessment report
      effect: write
      questions:
      - How do I generate a Best Practice Assessment report for a firewall?
      - What device details are required to start a BPA report?
      instructions:
      - text: Generate a BPA report for serial {serial} model {model} family {family} version {version} requested by {requester-name} at {requester-email}.
        slots:
          serial: requestBody.serial
          model: requestBody.model
          family: requestBody.family
          version: requestBody.version
          requester-name: requestBody.requester-name
          requester-email: requestBody.requester-email
      - text: Start a BPA assessment for firewall {serial} ({model}, {family}, PAN-OS {version}) for {requester-name}, {requester-email}.
        slots:
          serial: requestBody.serial
          model: requestBody.model
          family: requestBody.family
          version: requestBody.version
          requester-name: requestBody.requester-name
          requester-email: requestBody.requester-email
      method: generated
      generated: '2026-09-26'