Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Network Services Config Match List API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-config-match-list-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['/config-match-list'].get
$.paths['/config-match-list'].post
$.paths['/config-match-list/{id}'].get
$.paths['/config-match-list/{id}'].put
$.paths['/config-match-list/{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 Config Match List API
  version: 1.0.0
extends: openapi/palo-alto-networks-config-match-list-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['/config-match-list'].get
  update:
    x-apievangelist-phrasing:
      intent: List config match list entries
      effect: read
      questions:
      - What config log match list entries are defined in a folder?
      - Can I filter config match lists by name or device?
      instructions:
      - text: List config match list entries in folder {folder}.
        slots:
          folder: query.folder
      - text: Find config match lists named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config-match-list'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a config match list entry
      effect: write
      questions:
      - How do I forward config logs that match a filter to syslog or email?
      - Can a config match list send logs to an HTTP server or SNMP trap?
      instructions:
      - text: Create a config match list named {name} with filter {filter}.
        slots:
          name: requestBody.name
          filter: requestBody.filter
      - text: Create config match list {name} that sends matching logs to syslog {send_syslog}.
        slots:
          name: requestBody.name
          send_syslog: requestBody.send_syslog
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config-match-list/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a config match list entry
      effect: read
      questions:
      - How can I view one config match list entry's filter and destinations?
      - Where are a config match list's forwarding targets shown?
      instructions:
      - text: Get config match list entry {id}.
        slots:
          id: path.id
      - text: Show the filter and destinations of config match list {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config-match-list/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a config match list entry
      effect: write
      questions:
      - Can I change the filter on an existing config match list?
      - Is it possible to add an email destination to a config match list I already have?
      instructions:
      - text: Update config match list {id} named {name} to use filter {filter}.
        slots:
          id: path.id
          name: requestBody.name
          filter: requestBody.filter
      - text: Make config match list {id} ({name}) email to {send_email}.
        slots:
          id: path.id
          name: requestBody.name
          send_email: requestBody.send_email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/config-match-list/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a config match list entry
      effect: destructive
      questions:
      - How do I delete a config match list entry?
      - Can I stop forwarding config logs by removing its match list?
      instructions:
      - text: Delete config match list entry {id}.
        slots:
          id: path.id
      - text: Remove the config match list with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'