Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Dig Security public Risk Findings API

4 actions 4 updates phrasing extends openapi/palo-alto-networks-risk-findings-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['/v1/risk-findings/id/{id}/status/{status}'].patch

$.paths['/v1/risk-findings'].get

$.paths['/v1/risk-findings/id/{id}'].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 Dig Security public Risk Findings API
  version: 1.0.0
extends: openapi/palo-alto-networks-risk-findings-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['/v1/risk-findings/id/{id}/status/{status}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a DSPM risk finding's status
      effect: write
      questions:
      - How do I mark a data security risk finding as resolved?
      - Can I reopen a risk finding by changing its status?
      instructions:
      - text: Set risk finding {id} to status {status}.
        slots:
          id: path.id
          status: path.status
      - text: Change the status of finding {id} to {status}.
        slots:
          id: path.id
          status: path.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/risk-findings'].get
  update:
    x-apievangelist-phrasing:
      intent: List DSPM risk findings
      effect: read
      questions:
      - Which data security risk findings are high severity right now?
      - Can I filter risk findings by cloud provider or affected asset name?
      - What findings affect assets tagged with a particular DSPM tag?
      instructions:
      - text: List risk findings with severity {severity}.
        slots:
          severity: query.severity.equals
      - text: Show risk findings for cloud provider {cloudProvider}.
        slots:
          cloudProvider: query.cloudProvider.equals
      - text: Find risk findings on assets whose name contains {asset}.
        slots:
          asset: query.affectedAssetName.contains
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/risk-findings/id/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Describe a DSPM risk finding
      effect: read
      questions:
      - What are the full details of one risk finding?
      - Which asset and rule triggered a particular finding?
      instructions:
      - text: Describe risk finding {id}.
        slots:
          id: path.id
      - text: Show the rule and affected asset for finding {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'