Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Config Operations Config Versions API

7 actions 7 updates phrasing extends openapi/palo-alto-networks-config-versions-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 7

$.info
$.paths['/config-versions:load'].post
$.paths['/config-versions/candidate:push'].post
$.paths['/config-versions'].get
$.paths['/config-versions/candidate'].delete
$.paths['/config-versions/{version}'].get
$.paths['/config-versions/running'].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 Config Operations Config Versions API
  version: 1.0.0
extends: openapi/palo-alto-networks-config-versions-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: 6
- target: $.paths['/config-versions:load'].post
  update:
    x-apievangelist-phrasing:
      intent: Load a config version into the candidate
      effect: write
      questions:
      - Can I load an older configuration version into my candidate config?
      - How would I restore a previous config version before pushing it?
      instructions:
      - text: Load configuration version {version} into the candidate config.
        slots:
          version: requestBody.version
      - text: Restore config version {version} as the candidate.
        slots:
          version: requestBody.version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config-versions/candidate:push'].post
  update:
    x-apievangelist-phrasing:
      intent: Push the candidate configuration
      effect: write
      questions:
      - How do I push my candidate configuration out to devices?
      - Can I push only one folder's candidate config with a description?
      instructions:
      - text: Push the candidate configuration for folder {folder}.
        slots:
          folder: requestBody.folder
      - text: Push the candidate config to {devices} with note {description}.
        slots:
          devices: requestBody.devices
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config-versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List configuration versions
      effect: read
      questions:
      - What configuration versions have been saved so far?
      - Can I page through the config version history?
      instructions:
      - text: List the configuration versions.
      - text: Show the latest {limit} configuration versions.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config-versions/candidate'].delete
  update:
    x-apievangelist-phrasing:
      intent: Discard the candidate config
      effect: destructive
      questions:
      - Can I throw away my candidate changes and roll back to the running config?
      - What happens if I delete the candidate configuration?
      instructions:
      - text: Delete the candidate configuration and roll back to running.
      - text: Discard all uncommitted candidate config changes.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config-versions/{version}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a specific configuration version
      effect: read
      questions:
      - How can I view the contents of one saved configuration version?
      - Is it possible to fetch a config by its version number?
      instructions:
      - text: Get configuration version {version}.
        slots:
          version: path.version
      - text: Show me config version {version}.
        slots:
          version: path.version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config-versions/running'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the running config version per folder
      effect: read
      questions:
      - Which configuration version is currently running in each folder?
      - What is live right now across my folders?
      instructions:
      - text: Show the running configuration version for each folder.
      - text: Get the current running config versions.
      method: generated
      generated: '2026-09-26'