Palo Alto Networks · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/palo-alto-networks-bpa-reports-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['/reports/{report_id}'].get
$.paths['/reports/{report_id}/checks'].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 AIOps for NGFW BPA BPA Reports API
  version: 1.0.0
extends: openapi/palo-alto-networks-bpa-reports-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['/reports/{report_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Best Practice Assessment report
      effect: read
      questions:
      - What overall and category scores did my firewall get in its Best Practice Assessment?
      - Which recommendations should I prioritize from a BPA report?
      instructions:
      - text: Get BPA report {report_id}.
        slots:
          report_id: path.report_id
      - text: Show the score and top recommendations from BPA report {report_id}.
        slots:
          report_id: path.report_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reports/{report_id}/checks'].get
  update:
    x-apievangelist-phrasing:
      intent: List check results in a BPA report
      effect: read
      questions:
      - Which individual best practice checks failed in a BPA report?
      - Can I filter BPA check results by category?
      instructions:
      - text: List checks in BPA report {report_id}.
        slots:
          report_id: path.report_id
      - text: Show {status} checks in the {category} category of report {report_id}.
        slots:
          status: query.status
          category: query.category
          report_id: path.report_id
      method: generated
      generated: '2026-09-26'