Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Security Services Data Filtering API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-datafiltering-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['/data-filtering-profiles'].get
$.paths['/data-filtering-profiles'].post
$.paths['/data-filtering-profiles/{id}'].get
$.paths['/data-filtering-profiles/{id}'].put
$.paths['/data-filtering-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 Security Services Data Filtering API
  version: 1.0.0
extends: openapi/palo-alto-networks-datafiltering-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['/data-filtering-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List data filtering profiles
      effect: read
      questions:
      - What data filtering profiles do I have configured for data loss prevention?
      - Can I list only the data filtering profiles defined in a particular folder, snippet or device?
      - Is there a way to find a data filtering profile by its name?
      instructions:
      - text: List the data filtering profiles in folder {folder}.
        slots:
          folder: query.folder
      - text: Find the data filtering profile named {name}.
        slots:
          name: query.name
      - text: Show data filtering profiles defined on device {device}.
        slots:
          device: query.device
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data-filtering-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a data filtering profile
      effect: write
      questions:
      - How do I create a new data filtering profile with its own rules?
      - Can I turn on data capture when I create a data filtering profile?
      instructions:
      - text: Create a data filtering profile named {name} described as {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      - text: Create data filtering profile {name} with rules {rules} and data capture enabled.
        slots:
          name: requestBody.name
          rules: requestBody.rules
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data-filtering-profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a data filtering profile by ID
      effect: read
      questions:
      - What rules are inside a specific data filtering profile?
      - Where do I see the full settings of one data filtering profile using its UUID?
      instructions:
      - text: Show data filtering profile {id}.
        slots:
          id: path.id
      - text: Get the rules and data capture setting of data filtering profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data-filtering-profiles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a data filtering profile
      effect: write
      questions:
      - How do I change the rules on a data filtering profile that already exists?
      - Can I disable override on an existing data filtering profile?
      instructions:
      - text: Replace the rules on data filtering profile {id} with {rules}.
        slots:
          id: path.id
          rules: requestBody.rules
      - text: Update the description of data filtering profile {id} to {description}.
        slots:
          id: path.id
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data-filtering-profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a data filtering profile
      effect: destructive
      questions:
      - How do I get rid of a data filtering profile I no longer use?
      - What happens when I delete a data filtering profile by its ID?
      instructions:
      - text: Delete data filtering profile {id}.
        slots:
          id: path.id
      - text: Remove the obsolete data filtering profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'