# 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 Scans API
  version: 1.0.0
extends: openapi/palo-alto-networks-scans-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: 18
- target: $.paths['/code/api/v1/scans/integrations'].post
  update:
    x-apievangelist-phrasing:
      intent: Refresh all resources with a full integration scan
      effect: write
      questions:
      - How do I force Application Security to rescan every cloud and IaC resource across my integrations?
      - Can I refresh the current state of all AWS, Azure and GCP resources on demand?
      instructions:
      - text: Trigger a full scan of all integrated resources to refresh their state.
      - text: Kick off an asynchronous rescan across every cloud provider and IaC integration.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/scans'].get
  update:
    x-apievangelist-phrasing:
      intent: List CI image scan results (v34.03)
      effect: read
      questions:
      - Where can I list all CI image scan results on the older v34.03 Compute API?
      - Can the v34.03 scan results list be filtered to failed scans for a given CI job?
      instructions:
      - text: Using the v34.03 API, list CI image scan results for job {jobName}.
        slots:
          jobName: query.jobName
      - text: On v34.03, list CI image scans for image {imageID} between {from} and {to}.
        slots:
          imageID: query.imageID
          from: query.from
          to: query.to
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/scans'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a CLI scan result (v34.03)
      effect: write
      questions:
      - How do I push a twistcli scan result into Console through the v34.03 API?
      - Can I record a CLI scan's pass or fail outcome with the v34.03 scans endpoint?
      instructions:
      - text: 'Via v34.03, add a CLI scan result for job {jobName}, build {build}, passed: {pass}.'
        slots:
          jobName: requestBody.jobName
          build: requestBody.build
          pass: requestBody.pass
      - text: Record a v34.03 CLI scan result with vulnerability summary {vulnFailureSummary}.
        slots:
          vulnFailureSummary: requestBody.vulnFailureSummary
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/scans/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download CI image scan results (v34.03)
      effect: read
      questions:
      - How can I export CI image scan results as a file from the v34.03 API?
      - Is there a v34.03 download of scan results limited to a date range?
      instructions:
      - text: Download the v34.03 CI image scan results for job {jobName}.
        slots:
          jobName: query.jobName
      - text: Export v34.03 CI scan results from {from} to {to} as a download.
        slots:
          from: query.from
          to: query.to
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.03/scans/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one CI image scan result (v34.03)
      effect: read
      questions:
      - How do I fetch a single CI image scan result by ID on the v34.03 API?
      - What does the v34.03 API return for one specific CI scan?
      instructions:
      - text: Get v34.03 CI image scan result {id}.
        slots:
          id: path.id
      - text: Using v34.03, show the details of CI scan {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/scans'].get
  update:
    x-apievangelist-phrasing:
      intent: List CI image scan results (v34.04)
      effect: read
      questions:
      - Which CI image scans failed in the latest v34.04 Compute API results?
      - Can I filter v34.04 CI scan results by build number or image ID?
      instructions:
      - text: List v34.04 CI image scan results for build {build}.
        slots:
          build: query.build
      - text: Show v34.04 CI image scans with pass status {pass}, sorted by {sort}.
        slots:
          pass: query.pass
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/scans'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a CLI scan result (v34.04)
      effect: write
      questions:
      - How do I submit a CLI scan result to the current v34.04 scans endpoint?
      - Can the v34.04 API store a compliance failure summary with a CLI scan result?
      instructions:
      - text: Add a v34.04 CLI scan result for job {jobName} and build {build}.
        slots:
          jobName: requestBody.jobName
          build: requestBody.build
      - text: Save a v34.04 CLI scan result with compliance summary {complianceFailureSummary}.
        slots:
          complianceFailureSummary: requestBody.complianceFailureSummary
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/scans/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download CI image scan results (v34.04)
      effect: read
      questions:
      - Can I download CI image scan results as a report file from the v34.04 API?
      - What filters apply when downloading v34.04 CI scan results, such as issue type?
      instructions:
      - text: Download v34.04 CI image scan results for image {imageID}.
        slots:
          imageID: query.imageID
      - text: Export v34.04 CI scan results filtered to issue type {issueType}.
        slots:
          issueType: query.issueType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v34.04/scans/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one CI image scan result (v34.04)
      effect: read
      questions:
      - How do I look up one CI image scan by its ID on the v34.04 API?
      - Which details does the v34.04 API give for a single CI image scan?
      instructions:
      - text: Get v34.04 CI image scan result {id}.
        slots:
          id: path.id
      - text: Open CI scan {id} from the v34.04 API.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/scans'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an AI red-team vulnerability scan
      effect: write
      questions:
      - How do I start an AI vulnerability scan against a registered model target?
      - Can I add custom attack prompts on top of the built-in attack library?
      - Is there a cap on the number of attacks run per category?
      instructions:
      - text: Start an AI vulnerability scan on target {target_id} testing categories {attack_categories}.
        slots:
          target_id: requestBody.target_id
          attack_categories: requestBody.attack_categories
      - text: Red-team target {target_id} on {attack_categories} with custom prompts {custom_prompts}, max {max_attacks_per_category} attacks each.
        slots:
          target_id: requestBody.target_id
          attack_categories: requestBody.attack_categories
          custom_prompts: requestBody.custom_prompts
          max_attacks_per_category: requestBody.max_attacks_per_category
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/scans/{scan_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an AI vulnerability scan's progress
      effect: read
      questions:
      - Has my AI red-team vulnerability scan finished yet?
      - What progress percentage does a running AI vulnerability scan report?
      instructions:
      - text: Check the progress of AI vulnerability scan {scan_id}.
        slots:
          scan_id: path.scan_id
      - text: Tell me whether AI red-team scan {scan_id} is completed.
        slots:
          scan_id: path.scan_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/scans/{scan_id}/results'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an AI vulnerability scan report
      effect: read
      questions:
      - What vulnerabilities did my completed AI red-team scan find, and what is the overall risk score?
      - Can I limit the AI scan report to high-severity findings in one attack category?
      instructions:
      - text: Get the vulnerability report for AI scan {scan_id}.
        slots:
          scan_id: path.scan_id
      - text: Show {severity} findings in category {category} from AI scan {scan_id}.
        slots:
          severity: query.severity
          category: query.category
          scan_id: path.scan_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scans/integrations'].get
  update:
    x-apievangelist-phrasing:
      intent: List CI/CD pipeline scan integrations
      effect: read
      questions:
      - Which CI/CD pipelines like Jenkins or GitHub Actions are configured for automated scanning?
      - Can I page through my configured CI platform scan integrations?
      instructions:
      - text: List my CI/CD scan integrations.
      - text: Show {limit} CI/CD scan integrations starting at offset {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scans'].get
  update:
    x-apievangelist-phrasing:
      intent: Get twistcli and CI/CD pipeline scan results
      effect: read
      questions:
      - What did the vulnerability and compliance scans from my CI/CD pipelines report?
      - Can I search pipeline scan results by scan target type?
      instructions:
      - text: Get CI/CD pipeline scan results matching {search}.
        slots:
          search: query.search
      - text: Show twistcli pipeline scan results of type {type}.
        slots:
          type: query.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scans'].post
  update:
    x-apievangelist-phrasing:
      intent: Trigger an IaC and SCA scan on a repository branch
      effect: write
      questions:
      - How do I scan one repository branch for IaC misconfigurations and vulnerable dependencies?
      - Can I choose which scan types run when triggering a repository scan?
      instructions:
      - text: Trigger an IaC and SCA scan of repository {repositoryId}.
        slots:
          repositoryId: requestBody.repositoryId
      - text: Scan branch {branch} of repository {repositoryId} with scan types {scanTypes}.
        slots:
          branch: requestBody.branch
          repositoryId: requestBody.repositoryId
          scanTypes: requestBody.scanTypes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scans/{scan_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a repository code scan's status
      effect: read
      questions:
      - Has the IaC scan I triggered on my repository completed?
      - What summary results does a finished repository code scan show?
      instructions:
      - text: Check the status of repository code scan {scan_id}.
        slots:
          scan_id: path.scan_id
      - text: Poll repository scan {scan_id} until it completes and summarize it.
        slots:
          scan_id: path.scan_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/scan/sync/request'].post
  update:
    x-apievangelist-phrasing:
      intent: Scan an AI prompt or response synchronously
      effect: write
      questions:
      - How do I check a user prompt or model response for threats and get the verdict right away?
      - Which AI security profile is applied when I scan a prompt in real time?
      instructions:
      - text: Scan contents {contents} synchronously with AI profile {ai_profile}.
        slots:
          contents: requestBody.contents
          ai_profile: requestBody.ai_profile
      - text: Run a real-time AI security scan on {contents} under profile {ai_profile} for session {session_id}.
        slots:
          contents: requestBody.contents
          ai_profile: requestBody.ai_profile
          session_id: requestBody.session_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/scan/async/request'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit an asynchronous AI security scan
      effect: write
      questions:
      - Can I queue AI prompt scans in the background and get a scan ID and report ID back?
      - What does an asynchronous AI security scan request return?
      instructions:
      - text: Submit an asynchronous AI security scan request.
      - text: Queue a background AI prompt scan and give me the scan_id and report_id.
      method: generated
      generated: '2026-09-26'