Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Palo Alto Networks Cortex XSOAR REST Playbooks API

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

$.paths['/playbook/run'].post

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 Cortex XSOAR REST Playbooks API
  version: 1.0.0
extends: openapi/palo-alto-networks-playbooks-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['/playbook'].get
  update:
    x-apievangelist-phrasing:
      intent: List XSOAR playbooks
      effect: read
      questions:
      - Which automated response playbooks are available in my XSOAR instance?
      - Can I search playbooks by keyword?
      instructions:
      - text: List all playbooks.
      - text: Find playbooks matching {query}.
        slots:
          query: query.query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/playbook/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a playbook on an incident
      effect: write
      questions:
      - How do I kick off a response playbook against an incident?
      - Can I run an older version of a playbook instead of the latest?
      instructions:
      - text: Run playbook {playbookId} on incident {incidentId}.
        slots:
          playbookId: requestBody.playbookId
          incidentId: requestBody.incidentId
      - text: Run version {version} of playbook {playbookId} against incident {incidentId}.
        slots:
          version: requestBody.version
          playbookId: requestBody.playbookId
          incidentId: requestBody.incidentId
      method: generated
      generated: '2026-09-26'