Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Data Resource Export API

5 actions 5 updates phrasing extends openapi/palo-alto-networks-dataresourceexport-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 5

$.info
$.paths['/api/sase/v2.0/resource/download'].post
$.paths['/api/sase/v2.0/resource/download/status'].post
$.paths['/api/sase/v2.0/resource/export/schedule/query/{resource_name}'].post
$.paths['/api/sase/v2.0/resourceexport/schedule/custom/query/{feature_name}/{resource_name}'].post

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 Data Resource Export API
  version: 1.0.0
extends: openapi/palo-alto-networks-dataresourceexport-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: 4
- target: $.paths['/api/sase/v2.0/resource/download'].post
  update:
    x-apievangelist-phrasing:
      intent: Download a custom resource export CSV
      effect: read
      questions:
      - How do I download the CSV produced by a custom resource export job?
      - Where do I get the results file once an export has finished?
      instructions:
      - text: Download the custom resource CSV for tenant {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      - text: Fetch the finished export file for tenant {tenant_id} and sub-tenant {subtenant}.
        slots:
          tenant_id: path.tenant_id
          subtenant: header.Prisma-SubTenant
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/sase/v2.0/resource/download/status'].post
  update:
    x-apievangelist-phrasing:
      intent: Check a resource export job status
      effect: read
      questions:
      - Is my custom resource export job finished yet?
      - What status does an export request report while it runs?
      instructions:
      - text: Check the export job status for tenant {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      - text: Show whether the custom resource request for tenant {tenant_id} is ready.
        slots:
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/sase/v2.0/resource/export/schedule/query/{resource_name}'].post
  update:
    x-apievangelist-phrasing:
      intent: Export a general resource to CSV
      effect: write
      questions:
      - Can I export every property of a resource to a CSV file?
      - Which properties and filter must I supply to export a general resource?
      instructions:
      - text: Export resource {resource_name} for tenant {tenant_id} with properties {properties} and filter {filter}.
        slots:
          resource_name: path.resource_name
          tenant_id: path.tenant_id
          properties: requestBody.properties
          filter: requestBody.filter
      - text: Schedule a general export of {resource_name} for tenant {tenant_id} filtered by {filter} with properties {properties}.
        slots:
          resource_name: path.resource_name
          tenant_id: path.tenant_id
          filter: requestBody.filter
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/sase/v2.0/resourceexport/schedule/custom/query/{feature_name}/{resource_name}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom resource export job
      effect: write
      questions:
      - Can I export custom data for a specific feature and resource combination?
      - What feature and resource names does the custom export job accept?
      instructions:
      - text: Create a custom export of {feature_name}/{resource_name} for tenant {tenant_id} with properties {properties} and filter {filter}.
        slots:
          feature_name: path.feature_name
          resource_name: path.resource_name
          tenant_id: path.tenant_id
          properties: requestBody.properties
          filter: requestBody.filter
      - text: Start a custom export job for feature {feature_name} resource {resource_name} in tenant {tenant_id} filtered by {filter}, including {properties}.
        slots:
          feature_name: path.feature_name
          resource_name: path.resource_name
          tenant_id: path.tenant_id
          filter: requestBody.filter
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'