Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Palo Alto Networks XQL API

3 actions 3 updates phrasing extends openapi/palo-alto-networks-xql-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['/xql/start_xql_query'].post
$.paths['/xql/get_query_results'].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 XQL API
  version: 1.0.0
extends: openapi/palo-alto-networks-xql-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['/xql/start_xql_query'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an XQL query
      effect: read
      questions:
      - How do I query endpoint and network telemetry in the Cortex XDR data lake?
      - Does running an XQL query return results right away or a query ID?
      instructions:
      - text: Start the XQL query {request_data}.
        slots:
          request_data: requestBody.request_data
      - text: Run an XQL search over the data lake with {request_data}.
        slots:
          request_data: requestBody.request_data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/xql/get_query_results'].post
  update:
    x-apievangelist-phrasing:
      intent: Get results of an XQL query
      effect: read
      questions:
      - When is my XQL query finished and ready to read?
      - Where do I collect the rows returned by an XQL query I started?
      instructions:
      - text: Get the results for XQL query {request_data}.
        slots:
          request_data: requestBody.request_data
      - text: Poll the XQL query in {request_data} until it succeeds or fails.
        slots:
          request_data: requestBody.request_data
      method: generated
      generated: '2026-09-26'