Automated commit 'IDNPALM-5470: Add detail to metadata's API document…

… (#1895)

* IDNPALM-5470: Add detail

* IDNPALM-5470: linter check

* IDNPALM-5470: Add x-sailpoint-userLevels' by github action: 12039374164

idn/sailpoint-api.v2024.yaml

@@ -2266,6 +2266,8 @@ components:
       $ref: ./v3/schemas/BrandingItemCreate.yaml
     RoleBulkUpdateResponse:
       $ref: "./v2024/schemas/role-metadata/RoleBulkUpdateResponse.yaml"
+    RoleGetAllBulkUpdateResponse:
+      $ref: "./v2024/schemas/role-metadata/RoleGetAllBulkUpdateResponse.yaml"
     RoleListFilterDTO:
       $ref: "./v2024/schemas/role-metadata/RoleListFilterDTO.yaml"
     RoleMetadataBulkUpdateByFilterRequest:

idn/v2024/paths/role-access-model-metadata/role-bulk-update-status.yaml

@@ -2,23 +2,25 @@ get:
   operationId: getBulkUpdateStatus
   summary: Get Bulk-Update Statuses
   description: >-
-    This API returns a list of all  bulk update process status of the tenant.
-
-    A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN  authority is required to call this API. 
+    This API returns a list of all unfinished bulk update process status of the tenant.
 
+  x-sailpoint-userLevels:
+    - ORG_ADMIN
+    - ROLE_ADMIN
+    - ROLE_SUBADMIN
   security:
-    - UserContextAuth: [ idn:role:update, idn:role-checked:update ]
+    - userAuth: [ idn:role:update, idn:role-checked:update ]
   tags:
     - Roles
   responses:
     '200':
-      description: successfully get the status of all bulk updates.
+      description: successfully get the status of all unfinished bulk updates request.
       content:
         application/json:
           schema:
             type: array
             items:
-              $ref: '../../schemas/role-metadata/RoleBulkUpdateResponse.yaml'
+              $ref: '../../schemas/role-metadata/RoleGetAllBulkUpdateResponse.yaml'
 
     '400':
       $ref: '../../../v3/responses/400.yaml'

idn/v2024/paths/role-access-model-metadata/role-id-access-model-metadata.yaml

@@ -4,6 +4,7 @@ post:
   description:
     This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value.
     A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API.
+    The maximum number of attributes in one role is 25.
     Custom metadata update, including ADD and REPLACE need suit licensed.
   tags:
     - Roles

idn/v2024/schemas/role-metadata/RoleGetAllBulkUpdateResponse.yaml

@@ -0,0 +1,27 @@
+type: object
+properties:
+  id:
+    type: string
+    description: ID of the task which is executing the bulk update. This also used
+      in to the bulk-update/** API to track status.
+    example: 2c9180867817ac4d017817c491119a20
+  type:
+    type: string
+    description: Type of the bulk update object.
+    example: Role
+  status:
+    type: string
+    description: The status of the bulk update request, only list unfinished request's status, the status could also checked by
+      getBulkUpdateStatus API
+    enum:
+      - CREATED
+      - PRE_PROCESS
+      - POST_PROCESS
+      - CHUNK_PENDING
+      - CHUNK_PROCESSING
+    example: CREATED
+  created:
+    type: string
+    description: Time when the bulk update request was created
+    format: date-time
+    example: 2020-10-08T18:33:52.029Z

idn/v2024/schemas/role-metadata/RoleMetadataBulkUpdateByFilterRequest.yaml

@@ -32,10 +32,10 @@ properties:
     description: The operation to be performed
     type: string
     enum:
-      - "add"
-      - "remove"
-      - "replace"
-    example: "replace"
+      - "ADD"
+      - "REMOVE"
+      - "REPLACE"
+    example: "REPLACE"
   replaceScope:
     description: The choice of update scope.
     type: string

idn/v2024/schemas/role-metadata/RoleMetadataBulkUpdateByIdRequest.yaml

@@ -17,10 +17,10 @@ properties:
     description: The operation to be performed
     type: string
     enum:
-      - "add"
-      - "remove"
-      - "replace"
-    example: "replace"
+      - "ADD"
+      - "REMOVE"
+      - "REPLACE"
+    example: "REPLACE"
   replaceScope:
     description: The choice of update scope.
     type: string

idn/v2024/schemas/role-metadata/RoleMetadataBulkUpdateByQueryRequest.yaml

@@ -34,10 +34,10 @@ properties:
     description: The operation to be performed
     type: string
     enum:
-      - "add"
-      - "remove"
-      - "replace"
-    example: "replace"
+      - "ADD"
+      - "REMOVE"
+      - "REPLACE"
+    example: "REPLACE"
   replaceScope:
     description: The choice of update scope.
     type: string