Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Palo Alto Networks Dashboard API

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

$.info
$.paths['/code/api/v2/dashboard/common-errors-by-policy'].post
$.paths['/code/api/v2/dashboard/errors-by-severity'].post
$.paths['/code/api/v2/dashboard/iac-errors-by-category'].post
$.paths['/code/api/v2/dashboard/package-licenses'].post
$.paths['/code/api/v2/dashboard/pr-issues-over-time'].post
$.paths['/code/api/v2/dashboard/top-cvss'].post
$.paths['/code/api/v2/dashboard/top-vulnerable-repositories'].post
$.paths['/code/api/v2/dashboard/vcs-scan-issues-over-time'].post
$.paths['/v1/dashboard/scan-statistics'].get
$.paths['/v1/dashboard/score-trend'].get
$.paths['/v1/dashboard/overview'].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 Palo Alto Networks Dashboard API
  version: 1.0.0
extends: openapi/palo-alto-networks-dashboard-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: 11
- target: $.paths['/code/api/v2/dashboard/common-errors-by-policy'].post
  update:
    x-apievangelist-phrasing:
      intent: List policies with the most open code issues
      effect: read
      questions:
      - Which code security policies are failing most often in my repositories?
      - What are the top policies by open issue count?
      instructions:
      - text: List the {size} policies with the most open issues.
        slots:
          size: requestBody.size
      - text: Show the most common policy errors in repositories {repositories}.
        slots:
          repositories: requestBody.repositories
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v2/dashboard/errors-by-severity'].post
  update:
    x-apievangelist-phrasing:
      intent: Count code issues by severity
      effect: read
      questions:
      - How many code issues do I have at each severity level?
      - Can I see the severity breakdown of issues for specific repositories?
      instructions:
      - text: Count code issues by severity for repositories {repositories}.
        slots:
          repositories: requestBody.repositories
      - text: Give me the issue severity breakdown for code categories {codeCategories}.
        slots:
          codeCategories: requestBody.codeCategories
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v2/dashboard/iac-errors-by-category'].post
  update:
    x-apievangelist-phrasing:
      intent: Count IaC misconfigurations by category
      effect: read
      questions:
      - What types of infrastructure-as-code misconfigurations are most common, like IAM or networking?
      - How many IaC issues fall into each category?
      instructions:
      - text: Count IaC misconfigurations by category for repositories {repositories}.
        slots:
          repositories: requestBody.repositories
      - text: Break down IaC errors by category at severities {severities}.
        slots:
          severities: requestBody.severities
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v2/dashboard/package-licenses'].post
  update:
    x-apievangelist-phrasing:
      intent: List the most frequent non-compliant package licenses
      effect: read
      questions:
      - Which non-compliant open source licenses show up most in my scanned repos?
      - Are any package licenses violating my compliance policies?
      instructions:
      - text: List the top {size} non-compliant package licenses.
        slots:
          size: requestBody.size
      - text: Show non-compliant licenses found in repositories {repositories}.
        slots:
          repositories: requestBody.repositories
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v2/dashboard/pr-issues-over-time'].post
  update:
    x-apievangelist-phrasing:
      intent: Chart pull request scan results per day
      effect: read
      questions:
      - How many pull requests failed, passed or got resolved each day?
      - Is my PR failure rate improving over time?
      instructions:
      - text: Show daily pull request statuses starting {startDate}.
        slots:
          startDate: requestBody.startDate
      - text: Chart failed, resolved and passed PRs since {startDate} for repositories {repositories}.
        slots:
          startDate: requestBody.startDate
          repositories: requestBody.repositories
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v2/dashboard/top-cvss'].post
  update:
    x-apievangelist-phrasing:
      intent: List vulnerabilities with the highest CVSS scores
      effect: read
      questions:
      - Which vulnerabilities in my code have the highest CVSS scores?
      - What are the worst CVEs in my repositories, with their risk factors?
      instructions:
      - text: List the top {size} vulnerabilities by CVSS score.
        slots:
          size: requestBody.size
      - text: Show the highest-CVSS CVEs in repositories {repositories}.
        slots:
          repositories: requestBody.repositories
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v2/dashboard/top-vulnerable-repositories'].post
  update:
    x-apievangelist-phrasing:
      intent: Rank repositories by critical and high issues
      effect: read
      questions:
      - Which repositories have the most high and critical severity errors?
      - Where should I focus remediation first across my repos?
      instructions:
      - text: Rank the top {size} repositories by critical error count.
        slots:
          size: requestBody.size
      - text: Show the most vulnerable repositories for code categories {codeCategories}.
        slots:
          codeCategories: requestBody.codeCategories
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v2/dashboard/vcs-scan-issues-over-time'].post
  update:
    x-apievangelist-phrasing:
      intent: Chart code issue statuses over 30 days
      effect: read
      questions:
      - How have my open, fix-pending, fixed and suppressed code issues changed day by day?
      - Are we fixing code issues faster than new ones appear?
      instructions:
      - text: Chart daily code issue statuses starting {startDate}.
        slots:
          startDate: requestBody.startDate
      - text: Show code issue trends since {startDate} at severities {severities}.
        slots:
          startDate: requestBody.startDate
          severities: requestBody.severities
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/dashboard/scan-statistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get scan statistics and risk profile
      effect: read
      questions:
      - How many scans have run and what is their status breakdown?
      - What does my overall scan risk profile look like?
      instructions:
      - text: Show scan counts, target statistics and status breakdown.
      - text: Give me the scan risk profile for the dashboard.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/dashboard/score-trend'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the risk score trend for a target
      effect: read
      questions:
      - How has the risk score for one of my scan targets changed over time?
      - Can I chart a target's scores between custom start and end dates?
      instructions:
      - text: Show the risk score trend for target {target_id}.
        slots:
          target_id: query.target_id
      - text: Chart scores for target {target_id} from {start_date} to {end_date}.
        slots:
          target_id: query.target_id
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/dashboard/overview'].get
  update:
    x-apievangelist-phrasing:
      intent: Get target counts by type
      effect: read
      questions:
      - How many scan targets do I have of each type?
      - What is on the scanning dashboard overview?
      instructions:
      - text: Count my scan targets by type.
      - text: Show the dashboard overview of targets.
      method: generated
      generated: '2026-09-26'