DOCS-7072 Local server builds and will be creating a PR and send for …

…review
PaloAltoNetworks · Dec 18, 2024 · f17c042 · f17c042
1 parent 677bd8a
commit f17c042
Show file tree

Hide file tree

Showing 5 changed files with 197 additions and 128 deletions.
diff --git a/openapi-specs/sase/sspm/SSPMconsolidated.yaml b/openapi-specs/sase/sspm/SSPMconsolidated.yaml
@@ -475,24 +475,24 @@ components:
 info:
   contact:
     email: [email protected]
-  description: "This Open API spec file represents the APIs available for\n[Palo Alto\
-    \ Networks SSPM](https://docs.paloaltonetworks.com/NEED-URL) APIs. \n??? Add description\
-    \ ???\nThese APIs use the common SASE authentication mechanism and base URL. See\
-    \ the\n[Prisma SASE API Get Started](https://pan.dev/sase/docs/getstarted) guide\
-    \ for more information.\n\nThis Open API spec file was created on December 16,\
-    \ 2024. To check for a more recent version of this file, see\n[Interconnect APIs\
-    \ on pan.dev](https://pan.dev/sase/api/mt-sp-interconnect/mt-interconnect-api.html).\
-    \ ??? Add respective URL ???\n\n\xA9 2024 Palo Alto Networks, Inc. Palo Alto Networks\
-    \ is a registered trademark of Palo\nAlto Networks. A list of our trademarks can\
-    \ be found at\n\n[https://www.paloaltonetworks.com/company/trademarks.html](https://www.paloaltonetworks.com/company/trademarks.html)\n\
+  description: "This Open API spec file represents the APIs available for [Palo Alto\
+    \ Networks SSPM](https://docs.paloaltonetworks.com/NEED-URL) APIs. \nSaaS Security\
+    \ Posture Management (SSPM) APIs provide tools for continuous monitoring, detection\
+    \ of misconfigured SaaS application settings.\nThese APIs use the common SASE\
+    \ authentication mechanism and base URL. \nSee the [Prisma SASE API Get Started](https://pan.dev/sase/docs/getstarted)\
+    \ guide for more information.\n\nThis Open API spec file was created on December\
+    \ 18, 2024. To check for a more recent version of this file, see\n[SaaS Security\
+    \ Posture Management APIs on pan.dev](https://pan.dev/sase/api/sspm/sspm-api.html).\n\
+    \n\xA9 2024 Palo Alto Networks, Inc. Palo Alto Networks is a registered trademark\
+    \ of Palo\nAlto Networks. A list of our trademarks can be found at\n\n[https://www.paloaltonetworks.com/company/trademarks.html](https://www.paloaltonetworks.com/company/trademarks.html)\n\
     \nAll other marks mentioned herein may be trademarks of their respective companies.\n"
   title: SaaS Security Posture Management APIs
   version: '1.0'
 openapi: 3.0.1
 paths:
   /sspm/api/v1/apps:
     get:
-      description: 'You can use this API to get the list of onboarded SaaS applications.
+      description: 'Retrieve the list of onboarded SaaS applications.
 
         '
       operationId: get-sspm-api-v1-apps
@@ -530,8 +530,8 @@ paths:
       - Registered Application
   /sspm/api/v1/apps/{app_id}:
     get:
-      description: 'You can use this API to get the basic details of the application
-        by providing app ID and tenant name.
+      description: 'Retrieve the basic details of the application by providing app
+        ID and tenant name.
 
         '
       operationId: get-sspm-api-v1-apps-app_id
@@ -559,8 +559,8 @@ paths:
       - Registered Application
   /sspm/api/v1/apps/{app_id}/configs:
     get:
-      description: 'You can use this API to get details on the application configuration
-        by providing app ID and tenant name.
+      description: 'Retrieve details on the application configuration by providing
+        app ID and tenant name.
 
         '
       operationId: get-sspm-api-v1-apps-app_id-configs
@@ -590,8 +590,8 @@ paths:
       - Registered Application
   /sspm/api/v1/apps/{app_id}/settings:
     get:
-      description: "You can use this API to get the details on the settings of the\
-        \ SaaS application by providing app ID and tenant name. \n"
+      description: "Retrieve details on the settings of the SaaS application by providing\
+        \ app ID and tenant name. \n"
       operationId: get-sspm-api-v1-apps-app_id-settings
       parameters:
       - description: application id
@@ -619,8 +619,7 @@ paths:
       - Registered Application
   /sspm/api/v1/auth/{app}/info:
     get:
-      description: 'You can use this API to get details on the application authorization
-        in the catalog.
+      description: 'Retrieve details on the application authorization in the catalog.
 
         '
       operationId: get-sspm-api-v1-auth-app-info
@@ -645,11 +644,10 @@ paths:
       - Bearer: []
       summary: Authorization information
       tags:
-      - Information
+      - Authorization
   /sspm/api/v1/catalog/apps:
     get:
-      description: "You can use this API to get details on all the supported SSPM\
-        \ applications. \n"
+      description: "Retrieve details on all the supported SSPM applications. \n"
       operationId: get-sspm-api-v1-catalog-apps
       responses:
         '200':
@@ -665,8 +663,8 @@ paths:
       - Catalog Information
   /sspm/api/v1/catalog/apps/{app}:
     get:
-      description: "You can use this API to get details on the catalog settings for\
-        \ the application by providing application type.  \n"
+      description: "Retrieve details on the catalog settings for the application by\
+        \ providing application type.  \n"
       operationId: get-sspm-api-v1-catalog-apps-app
       parameters:
       - description: application name
@@ -690,8 +688,8 @@ paths:
       - Catalog Information
   /sspm/api/v1/catalog/apps/{app}/configs:
     get:
-      description: 'You can use this API to get details on the catalog configuration
-        settings by providing application type.
+      description: 'Retrieve details on the catalog configuration settings by providing
+        application type.
 
         '
       operationId: get-sspm-api-v1-catalog-apps-app-configs
@@ -719,7 +717,8 @@ paths:
       - Catalog Information
   /sspm/api/v1/catalog/apps/{app}/scopes:
     get:
-      description: "??? Add description ??? \n"
+      description: "Retrieve plugin scope catalog for the application using application\
+        \ type. \n"
       operationId: get-sspm-api-v1-catalog-apps-app-scopes
       parameters:
       - description: application name
@@ -740,12 +739,14 @@ paths:
           description: successful operation
       security:
       - Bearer: []
-      summary: Fetch plugin scope catalog for for given app by app_type
+      summary: Plugin scope catalog
       tags:
       - Catalog Information
   /sspm/api/v1/catalog/controls/{common_control_id}:
     get:
-      description: "??? Add description ??? \n"
+      description: 'Retrieve a compliance profile mappings for common control ID.
+
+        '
       operationId: get-sspm-api-v1-catalog-controls-common_control_id
       parameters:
       - description: common control id
@@ -764,12 +765,15 @@ paths:
           description: successful operation
       security:
       - Bearer: []
-      summary: compliance profile mappings for given common control
+      summary: Compliance profile mappings
       tags:
       - Catalog Information
   /sspm/api/v1/integration/integrations/{integration_id}/{integration_type}/issue/{key}:
     get:
-      description: "??? Add description ??? \n"
+      description: 'Retrieve detailed information about a specific issue using the
+        issue key.
+
+        '
       operationId: get-sspm-api-v1-integration-integrations-integration_id-integration_type-issue-key
       parameters:
       - description: integration id
@@ -804,12 +808,13 @@ paths:
           description: not registered jira-ticketing integration
       security:
       - Bearer: []
-      summary: Fetch onboarded JIRA ticketing issue details by key
+      summary: JIRA ticket issue details
       tags:
-      - JIRA Issue
+      - JIRA
   /sspm/api/v1/integration/integrations/{integration_id}/{integration_type}/project/{key}:
     get:
-      description: "??? Add description ??? \n"
+      description: "Retrieve detailed information about a project. \nThe response\
+        \ includes issue keys that you can use in the next step.\n"
       operationId: get-sspm-api-v1-integration-integrations-integration_id-integration_type-project-key
       parameters:
       - description: integration id
@@ -844,12 +849,12 @@ paths:
           description: not registered jira-ticketing integration
       security:
       - Bearer: []
-      summary: Fetch onboarded JIRA ticketing project details by key
+      summary: Get specific information using issue key
       tags:
-      - JIRA Issue
+      - JIRA
   /sspm/api/v1/integration/integrations/{integration_id}/{integration_type}/projects:
     get:
-      description: "??? Add description ??? \n"
+      description: "Retrieve a list of JIRA tickets. \n"
       operationId: get-sspm-api-v1-integration-integrations-integration_id-integration_type-projects
       parameters:
       - description: integration id
@@ -877,23 +882,19 @@ paths:
           description: not registered jira-ticketing integration
       security:
       - Bearer: []
-      summary: Fetch onboarded JIRA ticketing project list
+      summary: List JIRA tickets
       tags:
-      - JIRA Issue
+      - JIRA
 servers:
 - url: https://api.sase.paloaltonetworks.com
 tags:
-- description: '??? Add description ???
+- description: 'Get registered application
 
     '
   name: Registered Application
-- description: '??? Add description ???
-
-    '
-  name: Information
-- description: '??? Add description ???
-
-    '
+- description: "Get authorization details for the given application. \n"
+  name: Authorization information
+- description: "Get catalog information for the application. \n"
   name: Catalog Information
 - description: 'Get JIRA issue details.
 

diff --git a/products/sase/api/sspm/api-workflow.md b/products/sase/api/sspm/api-workflow.md