Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Posture Management Config Upload API

3 actions 3 updates phrasing extends openapi/palo-alto-networks-config-upload-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['/checks/v1/reports/config-file-upload'].post

$.paths['/checks/v1/reports/{id}/bpa-result'].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 Posture Management Config Upload API
  version: 1.0.0
extends: openapi/palo-alto-networks-config-upload-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['/checks/v1/reports/config-file-upload'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a config file upload for best practice assessment
      effect: write
      questions:
      - How do I upload a firewall config to run a Best Practice Assessment?
      - Can I have my uploaded config deleted right after it is processed?
      instructions:
      - text: 'Start a config upload for a BPA and delete the file after processing: {delete}.'
        slots:
          delete: requestBody.delete_after_processing
      - text: Get a signed upload URL for my firewall config, with delete-after-processing {delete}.
        slots:
          delete: requestBody.delete_after_processing
      method: generated
      generated: '2026-09-26'
- target: $.paths['/checks/v1/reports/{id}/bpa-result'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a Best Practice Assessment result
      effect: read
      questions:
      - Has my Best Practice Assessment finished processing?
      - What does a completed BPA report say about my config?
      instructions:
      - text: Check the BPA status for task {id}.
        slots:
          id: path.id
      - text: Get the Best Practice Assessment result for upload {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'