# 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 Hipmatch Match List API
  version: 1.0.0
extends: openapi/palo-alto-networks-hipmatch-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['/hipmatch-match-list'].get
  update:
    x-apievangelist-phrasing:
      intent: List HIP match log forwarding entries
      effect: read
      questions:
      - Which HIP match list entries are configured in a folder or snippet?
      - Can I find a hipmatch match list entry by name?
      instructions:
      - text: List hipmatch match list entries in folder {folder}.
        slots:
          folder: query.folder
      - text: Find the hipmatch match list entry named {name}.
        slots:
          name: query.name
      - text: Show hipmatch match list entries defined in snippet {snippet}.
        slots:
          snippet: query.snippet
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hipmatch-match-list'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a HIP match list entry
      effect: write
      questions:
      - How do I forward HIP match logs to syslog or email?
      - Can a hipmatch match list entry quarantine matching devices?
      instructions:
      - text: Create hipmatch match list entry {name} with filter {filter}.
        slots:
          name: requestBody.name
          filter: requestBody.filter
      - text: Add HIP match entry {name} that sends to syslog {send_syslog} and email {send_email}.
        slots:
          name: requestBody.name
          send_syslog: requestBody.send_syslog
          send_email: requestBody.send_email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hipmatch-match-list/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a HIP match list entry
      effect: read
      questions:
      - What filter and forwarding targets does a specific hipmatch entry use?
      - Can I fetch a hipmatch match list entry by UUID?
      instructions:
      - text: Get hipmatch match list entry {id}.
        slots:
          id: path.id
      - text: Show the filter and destinations of HIP match entry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hipmatch-match-list/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a HIP match list entry
      effect: write
      questions:
      - Can I change the filter on an existing hipmatch match list entry?
      - How do I start sending an existing HIP match entry to Panorama?
      instructions:
      - text: Update hipmatch entry {id} ({name}) to filter {filter}.
        slots:
          id: path.id
          name: requestBody.name
          filter: requestBody.filter
      - text: Set send_to_panorama to {send_to_panorama} on HIP match entry {id} named {name}.
        slots:
          send_to_panorama: requestBody.send_to_panorama
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hipmatch-match-list/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a HIP match list entry
      effect: destructive
      questions:
      - What's the way to remove a hipmatch match list entry?
      - Can I delete a HIP match forwarding entry by UUID?
      instructions:
      - text: Delete hipmatch match list entry {id}.
        slots:
          id: path.id
      - text: Remove HIP match entry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'