Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Network Services Userid Match List API

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

$.paths['/userid-match-list'].post

$.paths['/userid-match-list/{id}'].get

$.paths['/userid-match-list/{id}'].put

$.paths['/userid-match-list/{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 Userid Match List API
  version: 1.0.0
extends: openapi/palo-alto-networks-userid-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['/userid-match-list'].get
  update:
    x-apievangelist-phrasing:
      intent: List User-ID match list entries
      effect: read
      questions:
      - Which User-ID match list entries exist in a folder?
      - Can I find a User-ID match list entry by name?
      instructions:
      - text: List the User-ID match list entries in folder {folder}.
        slots:
          folder: query.folder
      - text: Find User-ID match list entry {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/userid-match-list'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a User-ID match list entry
      effect: write
      questions:
      - How do I forward User-ID log matches to syslog or email?
      - Can a match list entry quarantine matching devices?
      - Can I send User-ID matches to Panorama?
      instructions:
      - text: Create User-ID match list entry {name} with filter {filter}.
        slots:
          name: requestBody.name
          filter: requestBody.filter
      - text: Add match list entry {name} that sends to syslog profiles {send_syslog}.
        slots:
          name: requestBody.name
          send_syslog: requestBody.send_syslog
      method: generated
      generated: '2026-09-26'
- target: $.paths['/userid-match-list/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a User-ID match list entry
      effect: read
      questions:
      - What filter and forwarding targets does one User-ID match list entry use?
      - Can I read a match list entry by UUID?
      instructions:
      - text: Get User-ID match list entry {id}.
        slots:
          id: path.id
      - text: Show the filter and forwarding of match list entry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/userid-match-list/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a User-ID match list entry
      effect: write
      questions:
      - How do I change the filter on an existing User-ID match list entry?
      - Can I turn on quarantine for a match list entry I already have?
      instructions:
      - text: Update match list entry {id} with name {name} and filter {filter}.
        slots:
          id: path.id
          name: requestBody.name
          filter: requestBody.filter
      - text: Set quarantine {quarantine} on existing match list entry {id} named {name}.
        slots:
          id: path.id
          quarantine: requestBody.quarantine
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/userid-match-list/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a User-ID match list entry
      effect: destructive
      questions:
      - Is there a way to remove a User-ID match list entry?
      - Can I delete a match list entry by UUID?
      instructions:
      - text: Delete User-ID match list entry {id}.
        slots:
          id: path.id
      - text: Remove match list entry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'