Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Network Services Ethernet Interfaces API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-ethernet-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['/ethernet-interfaces'].get
$.paths['/ethernet-interfaces'].post
$.paths['/ethernet-interfaces/{id}'].get
$.paths['/ethernet-interfaces/{id}'].put
$.paths['/ethernet-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 Ethernet Interfaces API
  version: 1.0.0
extends: openapi/palo-alto-networks-ethernet-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['/ethernet-interfaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List ethernet interfaces
      effect: read
      questions:
      - Which ethernet interfaces are configured on a firewall device?
      - Can I look up an ethernet interface by name like ethernet1/1?
      instructions:
      - text: List ethernet interfaces on device {device}.
        slots:
          device: query.device
      - text: Find the ethernet interface named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ethernet-interfaces'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an ethernet interface
      effect: write
      questions:
      - How do I configure a new ethernet interface?
      - Can I set link speed and duplex when adding an ethernet interface?
      instructions:
      - text: Create ethernet interface {name} with id {id}.
        slots:
          name: requestBody.name
          id: requestBody.id
      - text: Add ethernet interface {name} (id {id}) at link speed {link_speed} and duplex {link_duplex}.
        slots:
          name: requestBody.name
          id: requestBody.id
          link_speed: requestBody.link_speed
          link_duplex: requestBody.link_duplex
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ethernet-interfaces/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an ethernet interface
      effect: read
      questions:
      - What is the link state and PoE setting of one ethernet interface?
      - Can I fetch a single ethernet interface by id?
      instructions:
      - text: Show ethernet interface {id}.
        slots:
          id: path.id
      - text: Get the configuration of ethernet interface {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ethernet-interfaces/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an ethernet interface
      effect: write
      questions:
      - How do I bring an existing ethernet interface link down administratively?
      - Can I change the comment on an ethernet interface already configured?
      instructions:
      - text: Set link state of existing ethernet interface {id} ({name}) to {link_state}.
        slots:
          id: path.id
          name: requestBody.name
          link_state: requestBody.link_state
      - text: Update ethernet interface {id} named {name} with comment {comment}.
        slots:
          id: path.id
          name: requestBody.name
          comment: requestBody.comment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ethernet-interfaces/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an ethernet interface
      effect: destructive
      questions:
      - How do I remove an ethernet interface configuration?
      - Can I delete an ethernet interface by its id?
      instructions:
      - text: Delete ethernet interface {id}.
        slots:
          id: path.id
      - text: Remove the ethernet interface configuration {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'