Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Email DLP API

4 actions 4 updates phrasing extends openapi/palo-alto-networks-email-dlp-api-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 4

$.info

$.paths['/incident/api/v1/incidents'].get

$.paths['/incident/api/v1/incidents/{incidentId}/status'].patch

$.paths['/report/api/v1/reports/{reportId}'].get

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 Email DLP API
  version: 1.0.0
extends: openapi/palo-alto-networks-email-dlp-api-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: 3
- target: $.paths['/incident/api/v1/incidents'].get
  update:
    x-apievangelist-phrasing:
      intent: List Email DLP incidents
      effect: read
      questions:
      - Which emails triggered data loss prevention incidents this week?
      - Can I filter Email DLP incidents by sender, severity or policy name?
      - How do I fetch the next batch of incidents after a previous request?
      instructions:
      - text: List Email DLP incidents from {from} to {to}.
        slots:
          from: query.from
          to: query.to
      - text: Show Email DLP incidents sent by {senders} with severity {severities}.
        slots:
          senders: query.senders
          severities: query.severities
      - text: Find Email DLP incidents triggered by policy {policy}.
        slots:
          policy: query.policy_names
      method: generated
      generated: '2026-09-26'
- target: $.paths['/incident/api/v1/incidents/{incidentId}/status'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an Email DLP incident's status
      effect: write
      questions:
      - How do I mark an Email DLP incident as resolved?
      - Can I change the status of a single email incident?
      instructions:
      - text: Set Email DLP incident {incident} to status {status}.
        slots:
          incident: path.incidentId
          status: requestBody.value
      - text: Update the status of email incident {incident}.
        slots:
          incident: path.incidentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/report/api/v1/reports/{reportId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a DLP report
      effect: read
      questions:
      - What sensitive data did a DLP report detect?
      - Can I include the matched content snippets in a DLP report?
      instructions:
      - text: Get DLP report {report}.
        slots:
          report: path.reportId
      - text: Fetch DLP report {report} with snippets set to {snippets}.
        slots:
          report: path.reportId
          snippets: query.fetchSnippets
      method: generated
      generated: '2026-09-26'