Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for v2 Data Profiles API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-data-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['/v2/api/data-profiles'].get

$.paths['/v2/api/data-profiles'].post

$.paths['/v2/api/data-profiles/{resourceId}'].get

$.paths['/v2/api/data-profiles/{resourceId}'].put

$.paths['/v2/api/data-profiles/{resourceId}'].patch

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 v2 Data Profiles API
  version: 1.0.0
extends: openapi/palo-alto-networks-data-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['/v2/api/data-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List data profiles
      effect: read
      questions:
      - Which DLP data profiles exist for my tenant?
      - Can I sort and page through data profiles?
      instructions:
      - text: List my data profiles.
      - text: List data profiles sorted by {sort}, page {page} of size {size}.
        slots:
          sort: query.sort
          page: query.page
          size: query.size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/api/data-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a data profile
      effect: write
      questions:
      - How do I create a data profile with my own detection rules?
      - Can I make a granular data profile?
      instructions:
      - text: Create data profile {name} with detection rules {detection_rules}.
        slots:
          name: requestBody.name
          detection_rules: requestBody.detection_rules
      - text: Add a granular data profile {name} set to {is_granular_data_profile} using rules {detection_rules}.
        slots:
          name: requestBody.name
          is_granular_data_profile: requestBody.is_granular_data_profile
          detection_rules: requestBody.detection_rules
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/api/data-profiles/{resourceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a data profile
      effect: read
      questions:
      - What detection rules does a particular data profile use?
      - Can I retrieve one data profile by its ID?
      instructions:
      - text: Get data profile {resourceId}.
        slots:
          resourceId: path.resourceId
      - text: Show the detection rules in data profile {resourceId}.
        slots:
          resourceId: path.resourceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/api/data-profiles/{resourceId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a data profile
      effect: write
      questions:
      - How do I fully overwrite a data profile's detection rules?
      - Will a full update drop fields I leave out of a data profile?
      instructions:
      - text: Replace data profile {resourceId} with name {name} and rules {detection_rules}.
        slots:
          resourceId: path.resourceId
          name: requestBody.name
          detection_rules: requestBody.detection_rules
      - text: Overwrite all of data profile {resourceId} using detection rules {detection_rules}, name {name}.
        slots:
          resourceId: path.resourceId
          detection_rules: requestBody.detection_rules
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/api/data-profiles/{resourceId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a data profile
      effect: write
      questions:
      - Can I change just the description of a data profile without resending everything?
      - How does a merge-patch update of a data profile work?
      instructions:
      - text: Patch data profile {resourceId} ({name}, type {profile_type}) with description {description}.
        slots:
          resourceId: path.resourceId
          name: requestBody.name
          profile_type: requestBody.profile_type
          description: requestBody.description
      - text: 'Merge-patch profile {resourceId}: keep name {name}, type {profile_type}.'
        slots:
          resourceId: path.resourceId
          name: requestBody.name
          profile_type: requestBody.profile_type
      method: generated
      generated: '2026-09-26'