Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Palo Alto Networks Benchmark Monitoring API

5 actions 5 updates phrasing extends openapi/palo-alto-networks-benchmark-monitoring-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 5

$.info
$.paths['/benchmark-monitoring'].post
$.paths['/benchmark-monitoring/download'].post
$.paths['/compliance-frameworks/v1/benchmark-monitoring'].post
$.paths['/compliance-frameworks/v1/benchmark-monitoring/download'].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 Benchmark Monitoring API
  version: 1.0.0
extends: openapi/palo-alto-networks-benchmark-monitoring-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: 4
- target: $.paths['/benchmark-monitoring'].post
  update:
    x-apievangelist-phrasing:
      intent: Query benchmark monitoring data
      effect: read
      questions:
      - Which best-practice checks are failing on my firewalls via the unversioned benchmark endpoint?
      - Can I filter benchmark monitoring results by severity and product?
      instructions:
      - text: Get benchmark monitoring data for product {product} with severity {severity}.
        slots:
          product: requestBody.product
          severity: requestBody.severity
      - text: Show benchmark results with check status {bpc_status} on device type {device_type}.
        slots:
          bpc_status: requestBody.bpc_status
          device_type: requestBody.device_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/benchmark-monitoring/download'].post
  update:
    x-apievangelist-phrasing:
      intent: Download benchmark monitoring data
      effect: read
      questions:
      - How do I export benchmark monitoring data from the unversioned endpoint as CSV?
      - Can I compress a benchmark data download?
      instructions:
      - text: Download benchmark data as {format}.
        slots:
          format: query.format
      - text: Export benchmark results for check {bpc_id} as {format} with compression {compression}.
        slots:
          bpc_id: requestBody.bpc_id
          format: query.format
          compression: query.compression
      method: generated
      generated: '2026-09-26'
- target: $.paths['/compliance-frameworks/v1/benchmark-monitoring'].post
  update:
    x-apievangelist-phrasing:
      intent: Query compliance framework benchmark data
      effect: read
      questions:
      - How do I pull benchmark compliance data from the compliance-frameworks v1 API?
      - Can I see compliance-framework benchmark results for one object and its remediation location?
      instructions:
      - text: Query compliance-frameworks v1 benchmark data for product {product}.
        slots:
          product: requestBody.product
      - text: Show compliance-frameworks benchmark results for object {object_id} of type {object_type}.
        slots:
          object_id: requestBody.object_id
          object_type: requestBody.object_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/compliance-frameworks/v1/benchmark-monitoring/download'].post
  update:
    x-apievangelist-phrasing:
      intent: Download compliance framework benchmark data
      effect: read
      questions:
      - Can I download compliance-frameworks v1 benchmark data as JSON instead of CSV?
      - How do I export compliance-framework benchmark results filtered by severity?
      instructions:
      - text: Download compliance-frameworks v1 benchmark data as {format}.
        slots:
          format: query.format
      - text: Export compliance-frameworks benchmark results with severity {severity} as {format}.
        slots:
          severity: requestBody.severity
          format: query.format
      method: generated
      generated: '2026-09-26'