Palo Alto Networks · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/palo-alto-networks-network-packet-broker-profiles-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_profiles'].get

$.paths['/network_packet_broker_profiles'].post

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

$.paths['/network_packet_broker_profiles/{id}'].put

$.paths['/network_packet_broker_profiles/{id}'].delete

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 Network Services Network Packet Broker Profiles API
  version: 1.0.0
extends: openapi/palo-alto-networks-network-packet-broker-profiles-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_profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List network packet broker profiles
      effect: read
      questions:
      - Which network packet broker profiles are defined in my configuration?
      - Can I page through packet broker profiles in one folder?
      instructions:
      - text: List network packet broker profiles in folder {folder}.
        slots:
          folder: query.folder
      - text: Show {limit} packet broker profiles starting at {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/network_packet_broker_profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a network packet broker profile
      effect: write
      questions:
      - How do I set up a packet broker profile to forward traffic to a security chain?
      - Can a new packet broker profile be routed or transparent with health checks?
      instructions:
      - text: Create packet broker profile {name} with ID {id} on primary interface {interface_primary}.
        slots:
          name: requestBody.name
          id: requestBody.id
          interface_primary: requestBody.interface_primary
      - text: Add a transparent packet broker profile {name} ({id}) with health check {health_check}.
        slots:
          name: requestBody.name
          id: requestBody.id
          health_check: requestBody.health_check
      method: generated
      generated: '2026-09-26'
- target: $.paths['/network_packet_broker_profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a network packet broker profile
      effect: read
      questions:
      - Which interfaces does a specific packet broker profile use?
      - Can I retrieve one packet broker profile by ID?
      instructions:
      - text: Get network packet broker profile {id}.
        slots:
          id: path.id
      - text: Show the interfaces of packet broker profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/network_packet_broker_profiles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a network packet broker profile
      effect: write
      questions:
      - Can I change the secondary interface on an existing packet broker profile?
      - How do I modify the flow direction of a packet broker profile?
      instructions:
      - text: Update packet broker profile {id} named {name} to secondary interface {interface_secondary}.
        slots:
          id: path.id
          name: requestBody.name
          interface_secondary: requestBody.interface_secondary
      - text: Change the flow of packet broker profile {id} ({name}) to {flow}.
        slots:
          id: path.id
          name: requestBody.name
          flow: requestBody.flow
      method: generated
      generated: '2026-09-26'
- target: $.paths['/network_packet_broker_profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a network packet broker profile
      effect: destructive
      questions:
      - Can I remove a packet broker profile we stopped using?
      - What do I need to delete a packet broker profile?
      instructions:
      - text: Delete network packet broker profile {id}.
        slots:
          id: path.id
      - text: Remove packet broker profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'