# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Palo Alto Networks Reports API
  version: 1.0.0
extends: openapi/palo-alto-networks-reports-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: 16
- target: $.paths['/report'].get
  update:
    x-apievangelist-phrasing:
      intent: List compliance report configurations
      effect: read
      questions:
      - Which compliance reports are configured for my cloud accounts?
      - Can I filter report configs by compliance standard or schedule frequency?
      instructions:
      - text: List report configs for compliance standard {standard}.
        slots:
          standard: query.policy.complianceStandard
      - text: Show report configurations for cloud type {cloudType}.
        slots:
          cloudType: query.cloud.type
      - text: List all my compliance report configs.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/report'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a compliance report configuration
      effect: write
      questions:
      - How do I set up a recurring compliance report for my AWS accounts?
      - Can I create a one-time compliance report instead of a scheduled one?
      instructions:
      - text: Create a compliance report named {name} for cloud {cloudType} targeting {target}.
        slots:
          name: requestBody.name
          cloudType: requestBody.cloudType
          target: requestBody.target
      - text: Add report config {name} of type {type} for {cloudType} with target {target}.
        slots:
          name: requestBody.name
          type: requestBody.type
          cloudType: requestBody.cloudType
          target: requestBody.target
      method: generated
      generated: '2026-09-26'
- target: $.paths['/report/type'].get
  update:
    x-apievangelist-phrasing:
      intent: List compliance report types by cloud
      effect: read
      questions:
      - What compliance report types are available for each cloud type?
      - Which kinds of reports can I generate for Azure versus GCP?
      instructions:
      - text: List the available compliance report types.
      - text: Show which report types each cloud supports.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/report/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a compliance report configuration
      effect: read
      questions:
      - How do I see the settings and pass/fail counts of one report config?
      - What does a specific compliance report configuration look like?
      instructions:
      - text: Get report config {id} with its pass and fail counts.
        slots:
          id: path.id
      - text: Show compliance report configuration {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/report/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a compliance report configuration
      effect: write
      questions:
      - Can I change the schedule of an existing recurring compliance report?
      - How do I rename or retarget a report configuration I already created?
      instructions:
      - text: Update report config {id} to name {name} for {cloudType} with target {target}.
        slots:
          id: path.id
          name: requestBody.name
          cloudType: requestBody.cloudType
          target: requestBody.target
      - text: Change the schedule target of report {id} to {target}, keeping name {name} and cloud {cloudType}.
        slots:
          id: path.id
          target: requestBody.target
          name: requestBody.name
          cloudType: requestBody.cloudType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/report/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a compliance report configuration
      effect: destructive
      questions:
      - How do I remove a compliance report configuration I no longer need?
      - Can I stop a scheduled report by deleting its config?
      instructions:
      - text: Delete report config {id}.
        slots:
          id: path.id
      - text: Remove the compliance report configuration {id} permanently.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/report/{id}/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the latest compliance report
      effect: read
      questions:
      - How do I download the most recent run of a scheduled compliance report?
      - Can I get the generated compliance report file for a report ID?
      instructions:
      - text: Download the latest compliance report for {id}.
        slots:
          id: path.id
      - text: Get the current generated report file of {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/report/{id}/history'].get
  update:
    x-apievangelist-phrasing:
      intent: List past runs of a scheduled report
      effect: read
      questions:
      - What past runs exist for a scheduled compliance report?
      - How do I see the history of generated reports for one report ID?
      instructions:
      - text: List the run history for report {id}.
        slots:
          id: path.id
      - text: Show metadata for every scheduled run of report {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/report/{id}/{lastScheduled}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get metadata for one historical report run
      effect: read
      questions:
      - What were the pass/fail counts of a compliance report on a particular date?
      - Can I look up a single historical report run by its timestamp?
      instructions:
      - text: Get report {id} run metadata generated at {lastScheduled}.
        slots:
          id: path.id
          lastScheduled: path.lastScheduled
      - text: Show pass and fail counts for report {id} from the {lastScheduled} run.
        slots:
          id: path.id
          lastScheduled: path.lastScheduled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/report/{id}/{lastScheduled}/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a historical report run
      effect: read
      questions:
      - How do I download an older compliance report instead of the latest one?
      - Can I retrieve the report file generated at a past timestamp?
      instructions:
      - text: Download report {id} as generated at {lastScheduled}.
        slots:
          id: path.id
          lastScheduled: path.lastScheduled
      - text: Get the archived report file for {id} from {lastScheduled}.
        slots:
          id: path.id
          lastScheduled: path.lastScheduled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filter/report/suggest'].get
  update:
    x-apievangelist-phrasing:
      intent: List compliance report filters and options
      effect: read
      questions:
      - Which filters can I use to narrow compliance posture reports?
      - What saved filter options exist for the report overview?
      instructions:
      - text: List all report overview filters and their options.
      - text: Show the available compliance posture report filters.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filter/report/suggest'].post
  update:
    x-apievangelist-phrasing:
      intent: Autocomplete values for a report filter
      effect: read
      questions:
      - What values are available for a specific report posture filter?
      - Can I fuzzy search the options of one report filter?
      instructions:
      - text: Suggest values for report filter {filterName}.
        slots:
          filterName: requestBody.filterName
      - text: Autocomplete {query} within report filter {filterName}.
        slots:
          query: requestBody.query
          filterName: requestBody.filterName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/report'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a compliance report configuration (v2)
      effect: write
      questions:
      - How do I create a report config with the v2 endpoint where a target is optional?
      - Can I schedule a recurring report through the v2 report API?
      instructions:
      - text: Create a v2 report config named {name} for {cloudType}.
        slots:
          name: requestBody.name
          cloudType: requestBody.cloudType
      - text: Use the v2 API to add a {type} report called {name} for {cloudType}.
        slots:
          type: requestBody.type
          name: requestBody.name
          cloudType: requestBody.cloudType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reports/summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a DLP incident summary report
      effect: read
      questions:
      - How many DLP incidents happened last month, broken down by severity and channel?
      - Who are the top users behind data loss incidents in a period?
      instructions:
      - text: Summarize DLP incidents between {start_time} and {end_time}.
        slots:
          start_time: query.start_time
          end_time: query.end_time
      - text: Build an executive DLP incident report from {start_time} to {end_time}.
        slots:
          start_time: query.start_time
          end_time: query.end_time
      method: generated
      generated: '2026-09-26'
- target: $.paths['/report/asset'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an IoT and OT asset inventory report
      effect: read
      questions:
      - What IoT and OT devices have been discovered, by category and risk level?
      - Can I get an asset inventory report broken down by site?
      instructions:
      - text: Get the IoT asset inventory report for customer {customerid}.
        slots:
          customerid: query.customerid
      - text: Show device inventory for customer {customerid}, {pagelength} per page.
        slots:
          customerid: query.customerid
          pagelength: query.pagelength
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/reports/usage'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a browser usage report
      effect: read
      questions:
      - How many active users and browser sessions did we have over a date range?
      - What blocked threats and DLP events came from secure browser usage?
      instructions:
      - text: Get browser usage stats from {start_date} to {end_date}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
      - text: Report browser usage between {start_date} and {end_date} grouped by {group_by}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
          group_by: query.group_by
      method: generated
      generated: '2026-09-26'