Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Unified Incident Framework Incidents APIs API

3 actions 3 updates phrasing extends openapi/palo-alto-networks-incidents-apis-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['/incidents/v1/search'].post
$.paths['/incidents/v1/details/{incident-id}'].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 Unified Incident Framework Incidents APIs API
  version: 1.0.0
extends: openapi/palo-alto-networks-incidents-apis-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['/incidents/v1/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search network security incidents
      effect: read
      questions:
      - Which network security incidents occurred in my tenant recently?
      - Can I filter and paginate incident search results?
      instructions:
      - text: Search incidents in region {region}.
        slots:
          region: header.X-PANW-Region
      - text: Find incidents in region {region} matching filter {filter}.
        slots:
          region: header.X-PANW-Region
          filter: requestBody.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/incidents/v1/details/{incident-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of a security incident
      effect: read
      questions:
      - What happened in a specific network security incident?
      - Can I see full information for one incident by its ID?
      instructions:
      - text: Get details for incident {incident_id} in region {region}.
        slots:
          incident_id: path.incident-id
          region: header.X-PANW-Region
      - text: Show everything about incident {incident_id}.
        slots:
          incident_id: path.incident-id
      method: generated
      generated: '2026-09-26'