# 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 Scan API
  version: 1.0.0
extends: openapi/palo-alto-networks-scan-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- 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} with transaction ID {tr_id}.
        slots:
          contents: requestBody.contents
          ai_profile: requestBody.ai_profile
          tr_id: requestBody.tr_id
      method: generated
      generated: '2026-10-01'
- 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 of {contents} using AI profile {ai_profile}.
        slots:
          contents: requestBody.contents
          ai_profile: requestBody.ai_profile
      - text: Queue a background AI prompt scan and give me the scan_id and report_id.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/scan/async/results/{scan_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get results of an asynchronous scan
      effect: read
      questions:
      - Has my asynchronous prompt scan finished, and what did it detect?
      - Where do I poll for the verdict of a queued AI security scan?
      instructions:
      - text: Get the results of async scan {scan_id}.
        slots:
          scan_id: path.scan_id
      - text: Check whether scan {scan_id} is done and show its detections.
        slots:
          scan_id: path.scan_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/scan'].get
  update:
    x-apievangelist-phrasing:
      intent: List scan jobs
      effect: read
      questions:
      - Which scan jobs are running or finished for my AI targets?
      - Can I filter scan jobs by status, type or target?
      instructions:
      - text: List my scan jobs with status {status}.
        slots:
          status: query.status
      - text: Show scan jobs for target {target_id} whose name matches {search}.
        slots:
          target_id: query.target_id
          search: query.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/scan'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a scan job against a target
      effect: write
      questions:
      - How do I start a new red-team style scan against one of my AI targets?
      - What do I need to supply to create a scan job?
      instructions:
      - text: Create a {job_type} scan named {name} against target {target}.
        slots:
          job_type: requestBody.job_type
          name: requestBody.name
          target: requestBody.target
      - text: Start scan job {name} on {target} with metadata {job_metadata}.
        slots:
          name: requestBody.name
          target: requestBody.target
          job_metadata: requestBody.job_metadata
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/scan/{job_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of a scan job
      effect: read
      questions:
      - What's the current status and configuration of a specific scan job?
      - Can I look up one scan job by its ID?
      instructions:
      - text: Show the details of scan job {job_id}.
        slots:
          job_id: path.job_id
      - text: Get the status of scan {job_id}.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/scan/{job_id}/abort'].post
  update:
    x-apievangelist-phrasing:
      intent: Abort a running scan job
      effect: destructive
      questions:
      - How do I stop a scan job that's still running?
      - Does aborting a scan cancel its workflow?
      instructions:
      - text: Abort running scan job {job_id}.
        slots:
          job_id: path.job_id
      - text: Cancel the workflow for scan {job_id}.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-09-26'