Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Network Services PBF Rules API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-pbf-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['/pbf-rules'].get
$.paths['/pbf-rules'].post
$.paths['/pbf-rules/{id}'].get
$.paths['/pbf-rules/{id}'].put
$.paths['/pbf-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 PBF Rules API
  version: 1.0.0
extends: openapi/palo-alto-networks-pbf-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['/pbf-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List policy-based forwarding rules
      effect: read
      questions:
      - Which policy-based forwarding rules are set up in a folder?
      - Can I look up a PBF rule by name?
      instructions:
      - text: List PBF rules in folder {folder}.
        slots:
          folder: query.folder
      - text: Find the policy-based forwarding rule named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pbf-rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a policy-based forwarding rule
      effect: write
      questions:
      - How do I route traffic for a specific application out a different path with a PBF rule?
      - Can a new forwarding rule enforce symmetric return traffic?
      instructions:
      - text: Create PBF rule {name} forwarding traffic from {source} to {destination} with action {action}.
        slots:
          name: requestBody.name
          source: requestBody.source
          destination: requestBody.destination
          action: requestBody.action
      - text: Add forwarding rule {name} for application {application} on schedule {schedule}.
        slots:
          name: requestBody.name
          application: requestBody.application
          schedule: requestBody.schedule
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pbf-rules/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a policy-based forwarding rule
      effect: read
      questions:
      - What source, destination and forwarding action does one PBF rule use?
      - How can I view a single forwarding rule by ID?
      instructions:
      - text: Get PBF rule {id}.
        slots:
          id: path.id
      - text: Show the forwarding action of PBF rule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pbf-rules/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a policy-based forwarding rule
      effect: write
      questions:
      - How do I change the forwarding action of an existing PBF rule?
      - Can I add source users to a PBF rule I already have?
      instructions:
      - text: Update PBF rule {id} to use action {action}.
        slots:
          id: path.id
          action: requestBody.action
      - text: Set source users {source_user} on existing PBF rule {id}.
        slots:
          source_user: requestBody.source_user
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pbf-rules/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a policy-based forwarding rule
      effect: destructive
      questions:
      - How do I delete a PBF rule?
      - Is a forwarding rule removed by its ID?
      instructions:
      - text: Delete PBF rule {id}.
        slots:
          id: path.id
      - text: Remove policy-based forwarding rule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'