Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Network Services LLDP Profiles API

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

$.paths['/lldp-profiles'].post

$.paths['/lldp-profiles/{id}'].get

$.paths['/lldp-profiles/{id}'].put

$.paths['/lldp-profiles/{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 LLDP Profiles API
  version: 1.0.0
extends: openapi/palo-alto-networks-lldp-profiles-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['/lldp-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List LLDP profiles
      effect: read
      questions:
      - Which LLDP profiles are defined in a folder?
      - Can I filter LLDP profiles by device or snippet?
      instructions:
      - text: List LLDP profiles in folder {folder}.
        slots:
          folder: query.folder
      - text: Find LLDP profiles named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lldp-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an LLDP profile
      effect: write
      questions:
      - How do I create an LLDP profile for firewall interfaces?
      - Can a new LLDP profile send SNMP syslog notifications?
      instructions:
      - text: Create LLDP profile {name}.
        slots:
          name: requestBody.name
      - text: Add LLDP profile {name} in mode {mode} with SNMP syslog notification {snmp_syslog_notification}.
        slots:
          name: requestBody.name
          mode: requestBody.mode
          snmp_syslog_notification: requestBody.snmp_syslog_notification
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lldp-profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an LLDP profile
      effect: read
      questions:
      - What mode and TLVs does a specific LLDP profile use?
      - Can I retrieve an LLDP profile by UUID?
      instructions:
      - text: Get LLDP profile {id}.
        slots:
          id: path.id
      - text: Show the settings of LLDP profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lldp-profiles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an LLDP profile
      effect: write
      questions:
      - Can I switch an existing LLDP profile to transmit-only mode?
      - Is it possible to change which optional TLVs an LLDP profile advertises?
      instructions:
      - text: Set LLDP profile {id} to mode {mode}, keeping name {name}.
        slots:
          id: path.id
          mode: requestBody.mode
          name: requestBody.name
      - text: Update optional TLVs on LLDP profile {id} ({name}) to {option_tlvs}.
        slots:
          id: path.id
          name: requestBody.name
          option_tlvs: requestBody.option_tlvs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lldp-profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an LLDP profile
      effect: destructive
      questions:
      - How do I remove an LLDP profile?
      - Can I delete an LLDP profile by UUID?
      instructions:
      - text: Delete LLDP profile {id}.
        slots:
          id: path.id
      - text: Remove LLDP profile with UUID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'