Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Network Services Network Packet Broker Rules API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-network-packet-broker-rules-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 6

$.info
$.paths['/network_packet_broker_rules'].get
$.paths['/network_packet_broker_rules'].post
$.paths['/network_packet_broker_rules/{id}'].get
$.paths['/network_packet_broker_rules/{id}'].put
$.paths['/network_packet_broker_rules/{id}'].delete

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 Network Services Network Packet Broker Rules API
  version: 1.0.0
extends: openapi/palo-alto-networks-network-packet-broker-rules-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: 5
- target: $.paths['/network_packet_broker_rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List Network Packet Broker rules
      effect: read
      questions:
      - Which Network Packet Broker rules are configured in a folder?
      - Can I page through packet broker rules with limit and offset?
      instructions:
      - text: List Network Packet Broker rules in folder {folder}.
        slots:
          folder: query.folder
      - text: Show the first {limit} packet broker rules.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/network_packet_broker_rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Network Packet Broker rule
      effect: write
      questions:
      - How do I create a packet broker rule that forwards traffic between specific zones?
      - Can a new packet broker rule match on applications and source users?
      instructions:
      - text: Create packet broker rule {name} with ID {id} and action {action}.
        slots:
          name: requestBody.name
          id: requestBody.id
          action: requestBody.action
      - text: Add broker rule {name} ({id}) from zones {from} to {to} with action {action}.
        slots:
          name: requestBody.name
          id: requestBody.id
          from: requestBody.from
          to: requestBody.to
          action: requestBody.action
      method: generated
      generated: '2026-09-26'
- target: $.paths['/network_packet_broker_rules/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Network Packet Broker rule
      effect: read
      questions:
      - What zones and action does a specific packet broker rule use?
      - Is a particular Network Packet Broker rule disabled?
      instructions:
      - text: Get Network Packet Broker rule {id}.
        slots:
          id: path.id
      - text: Show the match criteria of packet broker rule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/network_packet_broker_rules/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Network Packet Broker rule
      effect: write
      questions:
      - Can I disable an existing packet broker rule without deleting it?
      - Is it possible to change the action on a Network Packet Broker rule?
      instructions:
      - text: Update packet broker rule {id} named {name} to action {action}.
        slots:
          id: path.id
          name: requestBody.name
          action: requestBody.action
      - text: Set disabled to {disabled} on broker rule {id}.
        slots:
          disabled: requestBody.disabled
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/network_packet_broker_rules/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Network Packet Broker rule
      effect: destructive
      questions:
      - Can I permanently remove a Network Packet Broker rule?
      - What happens to brokered traffic when its rule is deleted?
      instructions:
      - text: Delete Network Packet Broker rule {id}.
        slots:
          id: path.id
      - text: Remove packet broker rule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'