Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Platform: Reporting Service Background Jobs API

5 actions 5 updates phrasing extends openapi/palo-alto-networks-background-jobs-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['/report-service/api/v1/report'].get
$.paths['/report-service/api/v1/report/{reportId}'].get
$.paths['/report-service/api/v1/report/{reportId}/status'].get
$.paths['/report-service/api/v1/report/{reportId}/download'].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 Platform: Reporting Service Background Jobs API'
  version: 1.0.0
extends: openapi/palo-alto-networks-background-jobs-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['/report-service/api/v1/report'].get
  update:
    x-apievangelist-phrasing:
      intent: List background report jobs
      effect: read
      questions:
      - Which background report jobs have I created in the last 30 days?
      - Can I filter background reports by report type?
      instructions:
      - text: List my background report jobs.
      - text: List background reports of type {report_types}, page {page}.
        slots:
          report_types: query.report_types
          page: query.page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/report-service/api/v1/report/{reportId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a background report's metadata
      effect: read
      questions:
      - What are the details of a particular background report job?
      - Can I read a report's metadata by its ID?
      instructions:
      - text: Get the metadata for report {reportId}.
        slots:
          reportId: path.reportId
      - text: Show report job {reportId}'s details.
        slots:
          reportId: path.reportId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/report-service/api/v1/report/{reportId}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a background report's status
      effect: read
      questions:
      - Is my background report finished yet?
      - What status is a report job in right now?
      instructions:
      - text: Check the status of report {reportId}.
        slots:
          reportId: path.reportId
      - text: Tell me whether report {reportId} is ready to download.
        slots:
          reportId: path.reportId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/report-service/api/v1/report/{reportId}/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a finished report
      effect: read
      questions:
      - How do I download the results of a finished background report?
      - What format does a downloaded report come in, zip or JSON?
      instructions:
      - text: Download report {reportId}.
        slots:
          reportId: path.reportId
      - text: Fetch the output file of background report {reportId}.
        slots:
          reportId: path.reportId
      method: generated
      generated: '2026-09-26'