Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Palo Alto Networks Jobs API

5 actions 5 updates phrasing extends openapi/palo-alto-networks-jobs-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['/jobs'].get

$.paths['/jobs/{id}'].get

$.paths['/device/jobs/{id}'].get

$.paths['/sse/config/v1/jobs/{id}'].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 Palo Alto Networks Jobs API
  version: 1.0.0
extends: openapi/palo-alto-networks-jobs-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['/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List configuration jobs
      effect: read
      questions:
      - What configuration jobs have run recently?
      - Can I see all my configuration push and commit jobs in one list?
      instructions:
      - text: List all configuration jobs.
      - text: Show my recent configuration jobs.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a configuration job
      effect: read
      questions:
      - What happened with a specific configuration job?
      - Can I look up a configuration job by its ID from the jobs list?
      instructions:
      - text: Show configuration job {id}.
        slots:
          id: path.id
      - text: Get the details of config job {id} from the jobs collection.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/device/jobs/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the status and results of a device job
      effect: read
      questions:
      - Has the asynchronous job running on my device finished yet?
      - Where do I get the results of a completed device job?
      instructions:
      - text: Check the status of device job {id}.
        slots:
          id: path.id
      - text: Poll device job {id} and return its results when complete.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/jobs/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the status of an SSE config push or commit job
      effect: read
      questions:
      - Did my Prisma Access configuration push or commit succeed?
      - What is the result of an asynchronous SSE config job?
      instructions:
      - text: Check the SSE config job {id} for push or commit status.
        slots:
          id: path.id
      - text: Get the result of Prisma Access async job {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'