Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Network Services DHCP Interfaces API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-dhcp-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['/dhcp-interfaces'].get
$.paths['/dhcp-interfaces'].post
$.paths['/dhcp-interfaces/{id}'].get
$.paths['/dhcp-interfaces/{id}'].put
$.paths['/dhcp-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 DHCP Interfaces API
  version: 1.0.0
extends: openapi/palo-alto-networks-dhcp-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['/dhcp-interfaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List DHCP interfaces
      effect: read
      questions:
      - Which DHCP interfaces are configured on a device or in a folder?
      - Can I look up a DHCP interface by interface name?
      instructions:
      - text: List DHCP interfaces in folder {folder}.
        slots:
          folder: query.folder
      - text: Show the DHCP interfaces defined on device {device}.
        slots:
          device: query.device
      - text: Find the DHCP interface named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dhcp-interfaces'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a DHCP interface
      effect: write
      questions:
      - How do I enable DHCP on a new interface?
      - What's required to create a DHCP interface entry?
      instructions:
      - text: Create a DHCP interface for {name}.
        slots:
          name: requestBody.name
      - text: Add interface {name} as a DHCP interface.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dhcp-interfaces/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a DHCP interface
      effect: read
      questions:
      - Can I fetch one DHCP interface by its UUID?
      - What interface name is behind a given DHCP interface ID?
      instructions:
      - text: Get DHCP interface {id}.
        slots:
          id: path.id
      - text: Show the configuration of DHCP interface {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dhcp-interfaces/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a DHCP interface
      effect: write
      questions:
      - Can I change which interface an existing DHCP interface entry points to?
      - Is there a way to edit a DHCP interface I already created?
      instructions:
      - text: Update DHCP interface {id} to use interface {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Point existing DHCP interface {id} at {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dhcp-interfaces/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a DHCP interface
      effect: destructive
      questions:
      - How do I stop an interface from serving DHCP by removing its entry?
      - Can I delete a DHCP interface by UUID?
      instructions:
      - text: Delete DHCP interface {id}.
        slots:
          id: path.id
      - text: Remove the DHCP interface entry with UUID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'