Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Network Services SD-WAN Rules API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-sd-wan-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['/sdwan-rules'].get

$.paths['/sdwan-rules'].post

$.paths['/sdwan-rules/{id}'].get

$.paths['/sdwan-rules/{id}'].put

$.paths['/sdwan-rules/{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 SD-WAN Rules API
  version: 1.0.0
extends: openapi/palo-alto-networks-sd-wan-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['/sdwan-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List SD-WAN rules
      effect: read
      questions:
      - Which SD-WAN traffic steering rules are defined in a folder?
      - Can I page through SD-WAN rules for a specific device?
      instructions:
      - text: List SD-WAN rules in folder {folder}.
        slots:
          folder: query.folder
      - text: List SD-WAN rules for device {device}, {limit} at a time.
        slots:
          device: query.device
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sdwan-rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an SD-WAN rule
      effect: write
      questions:
      - How do I steer an application's traffic using a path quality profile?
      - Can a new SD-WAN rule use an error correction or SaaS quality profile?
      instructions:
      - text: Create SD-WAN rule {name} for app {application} using path quality profile {path_quality_profile}, action {action}, at {position}.
        slots:
          name: requestBody.name
          application: requestBody.application
          path_quality_profile: requestBody.path_quality_profile
          action: requestBody.action
          position: requestBody.position
      - text: Add SD-WAN rule {name} from zone {from} to {to}, sources {source}, destinations {destination}.
        slots:
          name: requestBody.name
          from: requestBody.from
          to: requestBody.to
          source: requestBody.source
          destination: requestBody.destination
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sdwan-rules/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an SD-WAN rule
      effect: read
      questions:
      - What applications and path quality profile does a particular SD-WAN rule use?
      - Can I look up an SD-WAN rule by ID?
      instructions:
      - text: Get SD-WAN rule {id}.
        slots:
          id: path.id
      - text: Show the match criteria and action of SD-WAN rule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sdwan-rules/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an SD-WAN rule
      effect: write
      questions:
      - Can I switch the path quality profile on an existing SD-WAN rule?
      - How do I disable an SD-WAN rule?
      instructions:
      - text: Update SD-WAN rule {id} to use path quality profile {path_quality_profile}.
        slots:
          id: path.id
          path_quality_profile: requestBody.path_quality_profile
      - text: Change SD-WAN rule {id} action to {action} for applications {application}.
        slots:
          id: path.id
          action: requestBody.action
          application: requestBody.application
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sdwan-rules/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an SD-WAN rule
      effect: destructive
      questions:
      - How do I remove an SD-WAN rule?
      - Is deleting an SD-WAN rule permanent?
      instructions:
      - text: Delete SD-WAN rule {id}.
        slots:
          id: path.id
      - text: Remove the SD-WAN rule with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'