Merge branch 'master' into DOCS-7072-security-posture

PaloAltoNetworks · Dec 18, 2024 · 87299f6 · 87299f6
2 parents f17c042 + 39672e2
commit 87299f6
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 40 deletions.
diff --git 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

diff --git a/package.json b/package.json
@@ -52,9 +52,9 @@
     "@docusaurus/theme-mermaid": "3.6.3",
     "algoliasearch": "^4.14.2",
     "clsx": "^1.2.1",
-    "docusaurus-plugin-openapi-docs": "4.3.0",
+    "docusaurus-plugin-openapi-docs": "4.3.1",
     "docusaurus-plugin-sass": "^0.2.2",
-    "docusaurus-theme-openapi-docs": "4.3.0",
+    "docusaurus-theme-openapi-docs": "4.3.1",
     "fast-xml-parser": "^4.0.10",
     "firebase": "^10.12.0",
     "plugin-sitemap-coveo": "./plugin-sitemap-coveo",

diff --git a/yarn.lock b/yarn.lock
@@ -5928,10 +5928,10 @@ dns-packet@^5.2.2:
   dependencies:
     "@leichtgewicht/ip-codec" "^2.0.1"
 
-[email protected].0:
-  version "4.3.0"
-  resolved "https://registry.npmjs.org/docusaurus-plugin-openapi-docs/-/docusaurus-plugin-openapi-docs-4.3.0.tgz#1e5891c10194e3ce585d894e911c80e352f0ed77"
-  integrity sha512-IOxJzLfH8vhGvzQSd9TI99w2naD705r838gaa1/oDlmcaajXYtKePkk7YwcqjLLKgJ/roQcvQAK2qNX/sijQvQ==
+[email protected].1:
+  version "4.3.1"
+  resolved "https://registry.npmjs.org/docusaurus-plugin-openapi-docs/-/docusaurus-plugin-openapi-docs-4.3.1.tgz#8e0a440e3073050e6e29cf8783e61b5749c3b2b8"
+  integrity sha512-uVv/mipiQzgqHIhgnTmJmsBW3UuuAufmuyXeHzQR8PGovsjMOKJU6YVDTd8qHlkXQ09IdoBLKG0RUZ9daNxt0w==
   dependencies:
     "@apidevtools/json-schema-ref-parser" "^11.5.4"
     "@redocly/openapi-core" "^1.10.5"
@@ -5956,10 +5956,10 @@ docusaurus-plugin-sass@^0.2.2:
   dependencies:
     sass-loader "^16.0.2"
 
-[email protected].0:
-  version "4.3.0"
-  resolved "https://registry.npmjs.org/docusaurus-theme-openapi-docs/-/docusaurus-theme-openapi-docs-4.3.0.tgz#9ffd32ea33a542db1d0b5609569310b112fad26c"
-  integrity sha512-tfuvnPiTy+HvKYHR+s0651W5rotHlAZtNVfI/6rl3OYmIw9v2abO9bcUt86JGvmLKYlSKNCtJIotLTY801j/TA==
+[email protected].1:
+  version "4.3.1"
+  resolved "https://registry.npmjs.org/docusaurus-theme-openapi-docs/-/docusaurus-theme-openapi-docs-4.3.1.tgz#c7248daef422a5707f3ea57339460f7c273386dc"
+  integrity sha512-AeMBDckf+L3CDybLuzxUnjfBOa4zvpfux+u8g2apMSRub1Zh17EdqSWapzHWcMRw3xmknR4kqMFboWLXhwW1ew==
   dependencies:
     "@hookform/error-message" "^2.0.1"
     "@reduxjs/toolkit" "^1.7.1"