Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Palo Alto Networks PAN-OS REST Commit API

3 actions 3 updates phrasing extends openapi/palo-alto-networks-commit-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['/Commit'].get
$.paths['/Commit'].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 PAN-OS REST Commit API
  version: 1.0.0
extends: openapi/palo-alto-networks-commit-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['/Commit'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of a firewall commit
      effect: read
      questions:
      - Has my firewall commit finished, and did it succeed?
      - How can I track the progress of a commit using its job ID?
      instructions:
      - text: Check the status of commit job {jobid}.
        slots:
          jobid: query.jobid
      - text: Poll commit job {jobid} until it completes.
        slots:
          jobid: query.jobid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Commit'].post
  update:
    x-apievangelist-phrasing:
      intent: Commit candidate configuration to the firewall
      effect: write
      questions:
      - How do I apply my staged configuration changes to the running firewall config?
      - Can I do a partial commit for specific admins, device groups or vsys?
      instructions:
      - text: Commit the candidate configuration to the firewall.
      - text: Run a commit with command {cmd}.
        slots:
          cmd: requestBody.cmd
      method: generated
      generated: '2026-09-26'