Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Network Services VLAN Interfaces API

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

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

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

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

$.paths['/vlan-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 VLAN Interfaces API
  version: 1.0.0
extends: openapi/palo-alto-networks-vlan-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['/vlan-interfaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List VLAN interfaces
      effect: read
      questions:
      - What VLAN interfaces are configured on my firewalls?
      - Can I list VLAN interfaces for a particular device?
      instructions:
      - text: List VLAN interfaces on device {device}.
        slots:
          device: query.device
      - text: Show VLAN interfaces in folder {folder}.
        slots:
          folder: query.folder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vlan-interfaces'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a VLAN interface
      effect: write
      questions:
      - How do I create a VLAN interface with a VLAN tag?
      - Can I set ARP entries and dynamic DNS on a new VLAN interface?
      instructions:
      - text: Create VLAN interface {name}.
        slots:
          name: requestBody.name
      - text: Add VLAN interface {name} with tag {vlan_tag} and MTU {mtu}.
        slots:
          name: requestBody.name
          vlan_tag: requestBody.vlan_tag
          mtu: requestBody.mtu
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vlan-interfaces/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a VLAN interface
      effect: read
      questions:
      - What VLAN tag and settings does a given VLAN interface have?
      - Can I view a VLAN interface by ID?
      instructions:
      - text: Show VLAN interface {id}.
        slots:
          id: path.id
      - text: Get the configuration of VLAN interface {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vlan-interfaces/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a VLAN interface
      effect: write
      questions:
      - Can I change the VLAN tag on an existing VLAN interface?
      - How do I edit ARP entries on a VLAN interface I already have?
      instructions:
      - text: Update VLAN interface {id} ({name}) to VLAN tag {vlan_tag}.
        slots:
          id: path.id
          name: requestBody.name
          vlan_tag: requestBody.vlan_tag
      - text: Set ARP entries {arp} on existing VLAN interface {id} named {name}.
        slots:
          arp: requestBody.arp
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vlan-interfaces/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a VLAN interface
      effect: destructive
      questions:
      - Can I delete a VLAN interface?
      - What removes an unused VLAN interface?
      instructions:
      - text: Delete VLAN interface {id}.
        slots:
          id: path.id
      - text: Remove the VLAN interface {id} from config.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'