Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Network Services Loopback Interfaces API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-loopback-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['/loopback-interfaces'].get
$.paths['/loopback-interfaces'].post
$.paths['/loopback-interfaces/{id}'].get
$.paths['/loopback-interfaces/{id}'].put
$.paths['/loopback-interfaces/{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 Loopback Interfaces API
  version: 1.0.0
extends: openapi/palo-alto-networks-loopback-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['/loopback-interfaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List loopback interfaces
      effect: read
      questions:
      - What loopback interfaces are configured on my firewalls?
      - Can I list loopback interfaces for a single device?
      instructions:
      - text: List loopback interfaces on device {device}.
        slots:
          device: query.device
      - text: Show loopback interfaces in folder {folder}.
        slots:
          folder: query.folder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/loopback-interfaces'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a loopback interface
      effect: write
      questions:
      - How do I add a loopback interface with an IP address?
      - Can I set MTU and a management profile when creating a loopback?
      instructions:
      - text: Create loopback interface {name}.
        slots:
          name: requestBody.name
      - text: Add loopback {name} with IP {ip} and MTU {mtu}.
        slots:
          name: requestBody.name
          ip: requestBody.ip
          mtu: requestBody.mtu
      method: generated
      generated: '2026-09-26'
- target: $.paths['/loopback-interfaces/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a loopback interface
      effect: read
      questions:
      - What IP addresses are assigned to a particular loopback interface?
      - Can I view a loopback interface by its ID?
      instructions:
      - text: Show loopback interface {id}.
        slots:
          id: path.id
      - text: Get the IPv4 and IPv6 settings of loopback {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/loopback-interfaces/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a loopback interface
      effect: write
      questions:
      - Can I change the IP on an existing loopback interface?
      - How do I attach a NetFlow profile to a loopback I already have?
      instructions:
      - text: Update loopback interface {id} named {name} to IP {ip}.
        slots:
          id: path.id
          name: requestBody.name
          ip: requestBody.ip
      - text: Set NetFlow profile {netflow_profile} on existing loopback {id} ({name}).
        slots:
          netflow_profile: requestBody.netflow_profile
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/loopback-interfaces/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a loopback interface
      effect: destructive
      questions:
      - Can I delete a loopback interface?
      - What removes an unused loopback from the configuration?
      instructions:
      - text: Delete loopback interface {id}.
        slots:
          id: path.id
      - text: Remove loopback {id} from the config.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'