Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Network Services Tunnel Interfaces API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-tunnel-interfaces-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['/tunnel-interfaces'].get

$.paths['/tunnel-interfaces'].post

$.paths['/tunnel-interfaces/{id}'].get

$.paths['/tunnel-interfaces/{id}'].put

$.paths['/tunnel-interfaces/{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 Tunnel Interfaces API
  version: 1.0.0
extends: openapi/palo-alto-networks-tunnel-interfaces-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['/tunnel-interfaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List tunnel interfaces
      effect: read
      questions:
      - Which tunnel interfaces are configured on a device?
      - Can I look up a tunnel interface by name?
      instructions:
      - text: List tunnel interfaces on device {device}.
        slots:
          device: query.device
      - text: Find tunnel interface {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tunnel-interfaces'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a tunnel interface
      effect: write
      questions:
      - How do I add a tunnel interface for a VPN with an IP address?
      - Can I set the MTU and a management profile on a new tunnel interface?
      instructions:
      - text: Create tunnel interface {name} with IP {ip}.
        slots:
          name: requestBody.name
          ip: requestBody.ip
      - text: Create tunnel interface {name} with MTU {mtu} and management profile {interface_management_profile}.
        slots:
          name: requestBody.name
          mtu: requestBody.mtu
          interface_management_profile: requestBody.interface_management_profile
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tunnel-interfaces/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a tunnel interface
      effect: read
      questions:
      - What IP addresses and MTU does a specific tunnel interface have?
      - How can I view one tunnel interface by ID?
      instructions:
      - text: Get tunnel interface {id}.
        slots:
          id: path.id
      - text: Show the IP and MTU settings of tunnel interface {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tunnel-interfaces/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a tunnel interface
      effect: write
      questions:
      - How do I change the MTU on an existing tunnel interface?
      - Can I add an IPv6 address or a NetFlow profile to a tunnel interface?
      instructions:
      - text: Update tunnel interface {id} ({name}) to MTU {mtu}.
        slots:
          id: path.id
          name: requestBody.name
          mtu: requestBody.mtu
      - text: Attach NetFlow profile {netflow_profile} to tunnel interface {id} named {name}.
        slots:
          netflow_profile: requestBody.netflow_profile
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tunnel-interfaces/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a tunnel interface
      effect: destructive
      questions:
      - How do I delete a tunnel interface?
      - Is a tunnel interface removed by ID?
      instructions:
      - text: Delete tunnel interface {id}.
        slots:
          id: path.id
      - text: Remove tunnel interface {id} from the configuration.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'