# 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 Errors API
  version: 1.0.0
extends: openapi/palo-alto-networks-errors-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/v1/errors/file'].post
  update:
    x-apievangelist-phrasing:
      intent: List code security errors in one file
      effect: read
      questions:
      - What misconfigurations were found in a specific file of my repository?
      - Can I filter a file's code errors by severity or category?
      instructions:
      - text: List errors in file {file} of repo {repo} from source {source}.
        slots:
          file: requestBody.filePath
          repo: requestBody.repository
          source: requestBody.sourceTypes
      - text: Show {severities} errors in {file} on branch {branch} of {repo}.
        slots:
          severities: requestBody.severities
          file: requestBody.filePath
          branch: requestBody.branch
          repo: requestBody.repository
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/errors/files'].post
  update:
    x-apievangelist-phrasing:
      intent: List files that have code errors
      effect: read
      questions:
      - Which files in my repository have security findings?
      - Can I narrow files with errors to one branch or file type?
      instructions:
      - text: List files with errors in repo {repo} from source {source}.
        slots:
          repo: requestBody.repository
          source: requestBody.sourceTypes
      - text: Show which {file_types} files in {repo} have findings.
        slots:
          file_types: requestBody.fileTypes
          repo: requestBody.repository
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/errors/files/{uuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get file metadata by UUID
      effect: read
      questions:
      - How do I get metadata for a scanned file when I only have its UUID?
      - What does the file metadata lookup return for a repository file?
      instructions:
      - text: Get metadata for file {uuid}.
        slots:
          uuid: path.uuid
      - text: Show scanned file {uuid} including {include}.
        slots:
          uuid: path.uuid
          include: query.include
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/errors/getFixedCode'].post
  update:
    x-apievangelist-phrasing:
      intent: Get remediated code for a finding
      effect: read
      questions:
      - Can I preview the fixed resource code for a misconfiguration before applying it?
      - What does the suggested fix look like for a code security error?
      instructions:
      - text: Show the fixed code for error {error}.
        slots:
          error: requestBody.error
      - text: Generate the remediated resource code for finding {error}.
        slots:
          error: requestBody.error
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/errors/gitBlameAuthors'].get
  update:
    x-apievangelist-phrasing:
      intent: List git blame authors of a repository
      effect: read
      questions:
      - Who are the git authors that committed to a given repository?
      - Can I list blame authors for a GitLab or Bitbucket repo?
      instructions:
      - text: List git blame authors for {repo} on {source}.
        slots:
          repo: query.fullRepoName
          source: query.sourceType
      - text: Show who committed to repository {repo}.
        slots:
          repo: query.fullRepoName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/errors/submitActions'].post
  update:
    x-apievangelist-phrasing:
      intent: Fix or suppress code security violations
      effect: write
      questions:
      - How do I open a pull request that fixes several violations at once?
      - Can I suppress some findings and fix others in the same submission?
      instructions:
      - text: Submit a {type} action fixing {fixes} and suppressing {suppressions}.
        slots:
          type: requestBody.type
          fixes: requestBody.violationsToFix
          suppressions: requestBody.violationsToSuppress
      - text: Suppress CVEs {cves} as part of a {type} submission.
        slots:
          cves: requestBody.cvesToSuppress
          type: requestBody.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/errors/supply-chain-fix'].post
  update:
    x-apievangelist-phrasing:
      intent: Remediate packages and IaC from supply chain view
      effect: write
      questions:
      - How do I fix vulnerable packages found on the supply chain screen?
      - Can I remediate IaC resources and packages for a repository together?
      instructions:
      - text: Remediate packages {packages} and resources {resources} in repository {repo}.
        slots:
          packages: requestBody.packagesToFix
          resources: requestBody.resourcesToFix
          repo: requestBody.repositoryId
      - text: Submit supply chain fixes for repository {repo}.
        slots:
          repo: requestBody.repositoryId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/code-issues/branch_scan'].post
  update:
    x-apievangelist-phrasing:
      intent: Get code issues from periodic branch scans
      effect: read
      questions:
      - What code issues did the scheduled branch scans find?
      - Can I page deep into periodic scan findings with search-after pagination?
      instructions:
      - text: Get periodic branch scan issues matching {filters}.
        slots:
          filters: requestBody.filters
      - text: Search periodic scan findings for {term} using filters {filters}.
        slots:
          term: requestBody.search
          filters: requestBody.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/code-issues/code_review_scan'].post
  update:
    x-apievangelist-phrasing:
      intent: Get code issues from PR and CI/CD scans
      effect: read
      questions:
      - Which issues were flagged in pull request reviews and CI/CD runs?
      - Can I search code review scan findings by keyword?
      instructions:
      - text: Get pull request and CI/CD scan issues matching {filters}.
        slots:
          filters: requestBody.filters
      - text: Show the first {limit} code review findings for {filters}.
        slots:
          limit: requestBody.limit
          filters: requestBody.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/git/blameAuthors'].post
  update:
    x-apievangelist-phrasing:
      intent: List blame authors across repositories
      effect: read
      questions:
      - Who are the authors across several of my repositories?
      - Can I search repository authors by name across repos?
      instructions:
      - text: List blame authors across repositories {repos}.
        slots:
          repos: requestBody.repositories
      - text: Search authors named {term} across my repositories.
        slots:
          term: query.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/errors/branch'].get
  update:
    x-apievangelist-phrasing:
      intent: List code security errors on a branch
      effect: read
      questions:
      - What Checkov policy violations exist on a given repository branch?
      - Can I filter branch errors by severity or status?
      instructions:
      - text: List errors on branch {branch} of repository {repo}.
        slots:
          branch: query.branch
          repo: query.repositoryId
      - text: Show {severity} errors on the default branch of repository {repo}.
        slots:
          severity: query.severity
          repo: query.repositoryId
      method: generated
      generated: '2026-09-26'