Automated commit by github action: 12206219948

sailpoint-oss · Dec 6, 2024 · 0701a15 · 0701a15
1 parent e0542c0
commit 0701a15
Show file tree

Hide file tree

Showing 6 changed files with 53 additions and 45 deletions.
diff --git a/static/api-specs/idn/beta/paths/managed-clients-path.yaml b/static/api-specs/idn/beta/paths/managed-clients-path.yaml
@@ -1,21 +1,21 @@
 get:
   tags:
     - Managed Clients
-  summary: Get a Managed Client
+  summary: Get Managed Client
   description: >-
-    Get a Managed Client.
+    Get a managed client by ID. 
   operationId: getManagedClient
   parameters:
     - name: id
       in: path
-      description: The Managed Client ID
+      description: Managed Client ID.
       required: true
       schema:
         type: string
       example: aClientId
   responses:
     "200":
-      description: Responds with a ManagedClient
+      description: ManagedClient response.
       content:
         application/json:
           schema:
@@ -37,28 +37,28 @@ get:
 patch:
   tags:
     - Managed Clients
-  summary: Update a Managed Clients
+  summary: Update Managed Client
   description: >-
-    Update an existing Managed Client.
+    Update an existing managed client.
   operationId: updateManagedClient
   parameters:
     - in: path
       name: id
       schema:
         type: string
       required: true
-      description: The Managed Client ID
+      description: Managed Client ID.
       example: aClientId
   requestBody:
     required: true
-    description: The JSONPatch payload used to update the schema.
+    description: JSONPatch payload used to update the schema.
     content:
       application/json-patch+json:
         schema:
           $ref: '../schemas/JsonPatch.yaml'
   responses:
     "200":
-      description: The updated ManagedClient
+      description: Updated ManagedClient.
       content:
         application/json:
           schema:
@@ -81,21 +81,21 @@ delete:
   operationId: deleteManagedClient
   tags:
     - Managed Clients
-  summary: Delete a Managed Client
+  summary: Delete Managed Client
   description: >-
-    Delete an existing Managed Client.
+    Delete an existing managed client.
   parameters:
     - in: path
       name: id
       schema:
         type: string
       required: true
-      description: The Managed Client ID
+      description: Managed Client ID.
       example: aClientId
   responses:
     '204':
       $ref: '../../v3/responses/204.yaml'
-      description: The Managed Client was successfully deleted.
+      description: Managed client was successfully deleted.
     '400':
       $ref: '../../v3/responses/400.yaml'
     '401':

diff --git a/static/api-specs/idn/beta/paths/managed-clients.yaml b/static/api-specs/idn/beta/paths/managed-clients.yaml
@@ -3,7 +3,7 @@ get:
     - Managed Clients
   summary: Get Managed Clients
   description: >-
-    Get a list of Managed Clients.
+    List managed clients.
   operationId: getManagedClients
   parameters:
     - $ref: '../../v3/parameters/offset.yaml'
@@ -33,7 +33,7 @@ get:
       example: name eq "client name"
   responses:
     "200":
-      description: Responds with a list of ManagedClient based on the query params provided
+      description: Response with a list of managed clients, based on the specified query parameters. 
       content:
         application/json:
           schema:
@@ -57,11 +57,11 @@ get:
 post:
   tags:
     - Managed Clients
-  summary: Create new Managed Clients
+  summary: Create Managed Client
   description: >-
-    Create a new Managed Client.
+    Create a new managed client.
 
-    The API returns a result that includes the Managed Client ID.
+    The API returns a result that includes the managed client ID.
   operationId: createManagedClient
   requestBody:
     required: true
@@ -71,7 +71,7 @@ post:
           $ref: '../schemas/ManagedClient.yaml'
   responses:
     "200":
-      description: The created ManagedClient
+      description: Created ManagedClient.
       content:
         application/json:
           schema:

diff --git a/static/api-specs/idn/sailpoint-api.v2024.yaml b/static/api-specs/idn/sailpoint-api.v2024.yaml
@@ -200,20 +200,25 @@ tags:
       Refer to [Managing User Accounts](https://documentation.sailpoint.com/saas/help/common/users/user_access.html#managing-user-accounts) for more information about accounts.
   - name: Application Discovery
     description: |
-      Use this API to discover applications within your Okta connector and receive connector recommendations by manually uploading application names.
+      Use this API to implement application discovery functionality. 
+      With this functionality in place, you can discover applications within your Okta connector and receive connector recommendations by manually uploading application names.
   - name: Approvals
     description: |
       Use this API to implement approval functionality. With this functionality in place, you can get generic approvals and modify them. 
       
       The main advantages this API has vs [Access Request Approvals](https://developer.sailpoint.com/docs/api/beta/access-request-approvals) are that you can use it to get generic approvals individually or in batches and make changes to those approvals. 
   - name: Apps 
     description: |
-      Use this API to implement source application functionality. With this functionality in place, you can create, customize, and manage applications within sources. 
+      Use this API to implement source application functionality. 
+      With this functionality in place, you can create, customize, and manage applications within sources.
   - name: Auth Profile
     description: |
-      Auth Profile - Represents authentication configuration for an Identity Profile. This object gets created when an Identity Profile is created.
-
-      APIs can be used to retrieve and update Auth Profiles.
+      Use this API to implement Auth Profile functionality. 
+      With this functionality in place, users can read authentication profiles and make changes to them. 
+      
+      An authentication profile represents an identity profile's authentication configuration. 
+      When the identity profile is created, its authentication profile is also created. 
+      An authentication profile includes information like its authentication profile type (`BLOCK`, `MFA`, `NON_PTA`, PTA`) and settings controlling whether or not it blocks access from off network or untrusted geographies. 
   - name: Auth Users
     description: |
       Use this API to implement user authentication system functionality. 
@@ -1093,7 +1098,9 @@ tags:
     description: Import and export configuration for some objects between tenants.
   - name: Suggested Entitlement Description
     description: |
-      Use this API to leverage power of LLM to generate suggested entitlement description.
+      Use this API to implement Suggested Entitlement Description (SED) functionality. 
+      SED functionality leverages the power of LLM to generate suggested entitlement descriptions. 
+      Refer to [GenAI Entitlement Descriptions](https://documentation.sailpoint.com/saas/help/access/entitlements.html#genai-entitlement-descriptions) to learn more about SED in Identity Security Cloud (ISC). 
   - name: Tagged Objects
     description: |
       Use this API to implement object tagging functionality. 

diff --git a/static/api-specs/idn/v3/paths/managed-client-status.yaml b/static/api-specs/idn/v3/paths/managed-client-status.yaml
@@ -1,27 +1,28 @@
 get:
   tags:
     - Managed Clients
-  summary: Get Managed Client Status.
-  description: Retrieve the Status of a Managed Client by ID.
+  summary: Get Managed Client Status
+  description: >-
+    Get a managed client's status, using its ID.
   operationId: getManagedClientStatus
   parameters:
     - name: id
       in: path
-      description: ID of the Managed Client to get Status of
+      description: Managed client ID to get status for. 
       required: true
       schema:
         type: string
         example: aClientId
     - name: type
       in: query
-      description: Type of the Managed Client to get Status of
+      description: Managed client type to get status for. 
       required: true
       schema:
         $ref: '../schemas/ManagedClientType.yaml'
         example: VA
   responses:
     "200":
-      description: Responds with the Status of the Managed Client with the given ID and Type.
+      description: Response with the managed client status, with the given ID and type.
       content:
         application/json:
           schema:

diff --git a/static/api-specs/idn/v3/paths/managed-client.yaml b/static/api-specs/idn/v3/paths/managed-client.yaml
@@ -37,21 +37,21 @@ get:
 patch:
   tags:
     - Managed Clients
-  summary: Update a Managed Client
+  summary: Update Managed Client
   description: >-
-    Update an existing Managed Client.
+    Update an existing managed client.
   operationId: updateManagedClient
   parameters:
     - in: path
       name: id
       schema:
         type: string
       required: true
-      description: Managed Client ID.
+      description: Managed client ID.
       example: 4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7
   requestBody:
     required: true
-    description: The JSONPatch payload used to update the object.
+    description: JSONPatch payload used to update the object.
     content:
       application/json-patch+json:
         schema:
@@ -60,7 +60,7 @@ patch:
             $ref: "../schemas/JsonPatchOperation.yaml"
   responses:
     "200":
-      description: The updated Managed Client
+      description: Updated managed client.
       content:
         application/json:
           schema:
@@ -83,21 +83,21 @@ delete:
   operationId: deleteManagedClient
   tags:
     - Managed Clients
-  summary: Delete a Managed Client
+  summary: Delete Managed Client
   description: >-
-    Delete an existing Managed Client.
+    Delete an existing managed client.
   parameters:
     - in: path
       name: id
       schema:
         type: string
       required: true
-      description: Managed Client ID.
+      description: Managed client ID.
       example: 4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7
   responses:
     '204':
       $ref: '../../v3/responses/204.yaml'
-      description: The Managed Client was successfully deleted.
+      description: Managed Client was successfully deleted.
     '400':
       $ref: '../../v3/responses/400.yaml'
     '401':

diff --git a/static/api-specs/idn/v3/paths/managed-clients.yaml b/static/api-specs/idn/v3/paths/managed-clients.yaml
@@ -3,7 +3,7 @@ get:
     - Managed Clients
   summary: Get Managed Clients
   description: >-
-    Get a list of Managed Clients.
+    List managed clients.
   operationId: getManagedClients
   parameters:
     - $ref: '../../v3/parameters/offset.yaml'
@@ -33,7 +33,7 @@ get:
       example: name eq "client name"
   responses:
     "200":
-      description: Responds with a list of ManagedClient based on the query params provided
+      description: Response with a list of managed clients, based on the specified query parameters.
       content:
         application/json:
           schema:
@@ -55,11 +55,11 @@ get:
 post:
   tags:
     - Managed Clients
-  summary: Create a new Managed Client
+  summary: Create Managed Client
   description: >-
-    Create a new Managed Client.
+    Create a new managed client.
 
-    The API returns a result that includes the Managed Client ID.
+    The API returns a result that includes the managed client ID.
   operationId: createManagedClient
   requestBody:
     required: true
@@ -69,7 +69,7 @@ post:
           $ref: '../schemas/ManagedClientRequest.yaml'
   responses:
     "200":
-      description: The created ManagedClient
+      description: Created ManagedClient.
       content:
         application/json:
           schema: