Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Network Services Interface Management Profiles API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-interface-management-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['/interface-management-profiles'].get
$.paths['/interface-management-profiles'].post
$.paths['/interface-management-profiles/{id}'].get
$.paths['/interface-management-profiles/{id}'].put
$.paths['/interface-management-profiles/{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 Interface Management Profiles API
  version: 1.0.0
extends: openapi/palo-alto-networks-interface-management-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['/interface-management-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List interface management profiles
      effect: read
      questions:
      - Which interface management profiles exist in my firewall configuration?
      - Can I filter interface management profiles by folder or device?
      instructions:
      - text: List interface management profiles in folder {folder}.
        slots:
          folder: query.folder
      - text: Find the interface management profile named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/interface-management-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an interface management profile
      effect: write
      questions:
      - How do I allow HTTPS, SSH or ping on a firewall interface?
      - Can I restrict interface management access to specific permitted IPs?
      instructions:
      - text: Create interface management profile {name}.
        slots:
          name: requestBody.name
      - text: Create management profile {name} allowing SSH {ssh} and ping {ping} from IPs {permitted_ip}.
        slots:
          name: requestBody.name
          ssh: requestBody.ssh
          ping: requestBody.ping
          permitted_ip: requestBody.permitted_ip
      method: generated
      generated: '2026-09-26'
- target: $.paths['/interface-management-profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an interface management profile
      effect: read
      questions:
      - Which management services does a particular interface profile allow?
      - Can I look up an interface management profile by ID?
      instructions:
      - text: Show interface management profile {id}.
        slots:
          id: path.id
      - text: Get the allowed services on management profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/interface-management-profiles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an interface management profile
      effect: write
      questions:
      - How do I turn off telnet on an existing interface management profile?
      - Can I change the permitted IPs on a management profile I already have?
      instructions:
      - text: Set telnet to {telnet} on interface management profile {id} named {name}.
        slots:
          telnet: requestBody.telnet
          id: path.id
          name: requestBody.name
      - text: Update the permitted IPs on management profile {id} named {name} to {permitted_ip}.
        slots:
          id: path.id
          name: requestBody.name
          permitted_ip: requestBody.permitted_ip
      method: generated
      generated: '2026-09-26'
- target: $.paths['/interface-management-profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an interface management profile
      effect: destructive
      questions:
      - How do I remove an interface management profile?
      - Can I delete a management profile by ID?
      instructions:
      - text: Delete interface management profile {id}.
        slots:
          id: path.id
      - text: Remove management profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'