Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Dig Security public Classification API

4 actions 4 updates phrasing extends openapi/palo-alto-networks-classification-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/classification/asset-files/id'].post
$.paths['/v1/classification/asset-fields/id'].post
$.paths['/v1/classification/data-types'].get

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 Dig Security public Classification API
  version: 1.0.0
extends: openapi/palo-alto-networks-classification-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/classification/asset-files/id'].post
  update:
    x-apievangelist-phrasing:
      intent: List classified files in a data asset
      effect: read
      questions:
      - Which files in a data asset contain sensitive data types?
      - Can I find public or malicious files within a classified asset?
      instructions:
      - text: List files in asset {id} labeled {label} with data type {dataType}, using key {key}.
        slots:
          id: query.id
          label: requestBody.label
          dataType: requestBody.dataType
          key: header.dig-api-key
      - text: 'Find malicious files in asset {id}: isMalicious {isMalicious}, extension {fileExtension}, key {key}.'
        slots:
          id: query.id
          isMalicious: requestBody.isMalicious
          fileExtension: requestBody.fileExtension
          key: header.dig-api-key
      - text: Get asset files for {id} using key {key}.
        slots:
          id: query.id
          key: header.dig-api-key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/classification/asset-fields/id'].post
  update:
    x-apievangelist-phrasing:
      intent: List classified fields in a data asset
      effect: read
      questions:
      - Which database fields in an asset hold sensitive data?
      - Can I filter an asset's classified fields by data type or label?
      instructions:
      - text: List fields in asset {id} with data type {dataType}, label {label}, field type {fieldType}, path {fieldPath}, name {fieldName}, key {key}.
        slots:
          id: query.id
          dataType: requestBody.dataType
          label: requestBody.label
          fieldType: requestBody.fieldType
          fieldPath: requestBody.fieldPath
          fieldName: requestBody.fieldName
          key: header.dig-api-key
      - text: Show classified fields for asset {id} using key {key}.
        slots:
          id: query.id
          key: header.dig-api-key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/classification/data-types'].get
  update:
    x-apievangelist-phrasing:
      intent: List data types found by classification
      effect: read
      questions:
      - What sensitive data types has classification found across my data?
      - Which data types were detected so far?
      instructions:
      - text: List found data types using API key {key}.
        slots:
          key: header.dig-api-key
      - text: Show every detected data type with key {key}.
        slots:
          key: header.dig-api-key
      method: generated
      generated: '2026-09-26'