From ea2ce9308a7c07637036617f98eec0c8f63477af Mon Sep 17 00:00:00 2001
From: divyabhushan <dbhushan@paloaltonetworks.com>
Date: Sat, 14 Dec 2024 10:54:49 +0530
Subject: [PATCH] Update APIs for auth

---
 .../ai-runtime-security/scan/ScanService.yaml | 44 ++++++-------------
 1 file changed, 14 insertions(+), 30 deletions(-)

diff --git a/openapi-specs/ai-runtime-security/scan/ScanService.yaml b/openapi-specs/ai-runtime-security/scan/ScanService.yaml
index b8b0968b4..7ffdd4d38 100644
--- a/openapi-specs/ai-runtime-security/scan/ScanService.yaml
+++ b/openapi-specs/ai-runtime-security/scan/ScanService.yaml
@@ -30,17 +30,11 @@ paths:
     post:
       summary: Send a Synchronous Scan Request
       description: Post a scan request containing prompt/model-response that returns a synchronous scan response
-      security: []
+      security:
+        - x-pan-token: []
       operationId: ScanSyncRequest
       tags:
         - Scans
-      parameters:
-        - description: API key token genereated during [onboarding AI Runtime Security API intercept](https://docs.paloaltonetworks.com/ai-runtime-security/activation-and-onboarding/ai-runtime-security-api-intercept-overview/onboard-api-runtime-security-api-intercept-in-scm) in SCM.
-          required: true
-          in: header
-          name: x-pan-token
-          schema:
-            type: string
       requestBody:
         description: Scan request object
         required: true
@@ -86,17 +80,11 @@ paths:
     post:
       summary: Send an Asynchronous Scan Request
       description: Post a scan request that returns asynchronous scan response
-      security: []
+      security:
+        - x-pan-token: []
       operationId: ScanAsyncRequest
       tags:
         - Scans
-      parameters:
-        - description: API key token genereated during [onboarding AI Runtime Security API intercept](https://docs.paloaltonetworks.com/ai-runtime-security/activation-and-onboarding/ai-runtime-security-api-intercept-overview/onboard-api-runtime-security-api-intercept-in-scm) in SCM.
-          required: true
-          in: header
-          name: x-pan-token
-          schema:
-            type: string
       requestBody:
         description: A list of scan request objects
         required: true
@@ -139,17 +127,12 @@ paths:
     get:
       summary: Retrieve Scan Results by ScanIDs
       description: Get the Scan results for upto a maximum of 5 Scan IDs
-      security: []
+      security: 
+        - x-pan-token: []
       operationId: GetScanResultsByScanIDs
       tags:
         - Scan Results
       parameters:
-        - description: API key token genereated during [onboarding AI Runtime Security API intercept](https://docs.paloaltonetworks.com/ai-runtime-security/activation-and-onboarding/ai-runtime-security-api-intercept-overview/onboard-api-runtime-security-api-intercept-in-scm) in SCM.
-          required: true
-          in: header
-          name: x-pan-token
-          schema:
-            type: string
         - name: scan_ids
           in: query
           description: Scan Ids for Results
@@ -199,17 +182,12 @@ paths:
     get:
       summary: Retrieve Threat Scan Reports by Report IDs
       description: Get the Threat Scan Reports for a given list of report_ids
-      security: []
+      security: 
+        - x-pan-token: []
       tags:
         - Scan Reports
       operationId: GetThreatScanReports
       parameters:
-        - description: API key token genereated during [onboarding AI Runtime Security API intercept](https://docs.paloaltonetworks.com/ai-runtime-security/activation-and-onboarding/ai-runtime-security-api-intercept-overview/onboard-api-runtime-security-api-intercept-in-scm) in SCM.
-          required: true
-          in: header
-          name: x-pan-token
-          schema:
-            type: string
         - name: report_ids
           in: query
           description: Report Ids for Results
@@ -254,6 +232,12 @@ paths:
                 $ref: '#/components/schemas/Error'
 
 components:
+  securitySchemes:
+    x-pan-token:
+      description: API key token generated during [onboarding AI Runtime Security API intercept](https://docs.paloaltonetworks.com/ai-runtime-security/activation-and-onboarding/ai-runtime-security-api-intercept-overview/onboard-api-runtime-security-api-intercept-in-scm) in Strata Cloud Manager.
+      in: header
+      name: x-pan-token
+      type: apiKey
   schemas:
     ScanRequest:
       type: object