NOISSUE - Use role id instead of name (#2612)

Signed-off-by: Arvindh <[email protected]>
absmach · Dec 25, 2024 · 6b16535 · 6b16535
1 parent 58ba597
commit 6b16535
Show file tree

Hide file tree

Showing 38 changed files with 1,784 additions and 1,840 deletions.
diff --git a/api/http/common.go b/api/http/common.go
@@ -198,6 +198,7 @@ func EncodeError(_ context.Context, err error, w http.ResponseWriter) {
 		errors.Contains(err, apiutil.ErrMissingParentGroupID),
 		errors.Contains(err, apiutil.ErrMissingConnectionType),
 		errors.Contains(err, apiutil.ErrMissingRoleName),
+		errors.Contains(err, apiutil.ErrMissingRoleID),
 		errors.Contains(err, apiutil.ErrMissingPolicyEntityType),
 		errors.Contains(err, apiutil.ErrMissingRoleMembers):
 		err = unwrap(err)

diff --git a/api/http/util/errors.go b/api/http/util/errors.go
@@ -78,9 +78,12 @@ var (
 	// ErrEmptyList indicates that entity data is empty.
 	ErrEmptyList = errors.New("empty list provided")
 
-	// ErrMissingRoleName indicates that role name are empty.
+	// ErrMissingRoleName indicates that role name is empty.
 	ErrMissingRoleName = errors.New("empty role name")
 
+	// ErrMissingRoleID indicates that role id is empty.
+	ErrMissingRoleID = errors.New("empty role id")
+
 	// ErrMissingRoleOperations indicates that role operations are empty.
 	ErrMissingRoleOperations = errors.New("empty role operations")
 

diff --git a/apidocs/openapi/clients.yml b/apidocs/openapi/clients.yml
@@ -454,7 +454,7 @@ paths:
           description: Database can't process request.
         "500":
           $ref: "#/components/responses/ServiceError"
-  
+
   /{domainID}/clients/{clientID}/roles:
     post:
       operationId: createClientRole
@@ -485,7 +485,7 @@ paths:
           description: Database can't process request.
         "500":
           $ref: "#/components/responses/ServiceError"
-    
+
     get:
       operationId: listClientRoles
       tags:
@@ -520,7 +520,7 @@ paths:
         "500":
           $ref: "#/components/responses/ServiceError"
 
-  /{domainID}/clients/{clientID}/roles/{roleName}:
+  /{domainID}/clients/{clientID}/roles/{roleID}:
     get:
       operationId: getClientRole
       tags:
@@ -531,7 +531,7 @@ paths:
       parameters:
         - $ref: "auth.yml#/components/parameters/DomainID"
         - $ref: "#/components/parameters/clientID"
-        - $ref: "./schemas/roles.yml#/components/parameters/RoleName"
+        - $ref: "./schemas/roles.yml#/components/parameters/RoleID"
       security:
         - bearerAuth: []
       responses:
@@ -550,7 +550,7 @@ paths:
           description: Database can't process request.
         "500":
           $ref: "#/components/responses/ServiceError"
-      
+
     put:
       operationId: updateClientRole
       summary: Updates client role.
@@ -561,7 +561,7 @@ paths:
       parameters:
         - $ref: "auth.yml#/components/parameters/DomainID"
         - $ref: "#/components/parameters/clientID"
-        - $ref: "./schemas/roles.yml#/components/parameters/RoleName"
+        - $ref: "./schemas/roles.yml#/components/parameters/RoleID"
       requestBody:
         $ref: "./schemas/roles.yml#/components/requestBodies/UpdateRoleReq"
       security:
@@ -582,7 +582,7 @@ paths:
           description: Database can't process request.
         "500":
           $ref: "#/components/responses/ServiceError"
-      
+
     delete:
       operationId: deleteClientRole
       summary: Deletes client role.
@@ -593,7 +593,7 @@ paths:
       parameters:
         - $ref: "auth.yml#/components/parameters/DomainID"
         - $ref: "#/components/parameters/clientID"
-        - $ref: "./schemas/roles.yml#/components/parameters/RoleName"
+        - $ref: "./schemas/roles.yml#/components/parameters/RoleID"
       security:
         - bearerAuth: []
       responses:
@@ -612,8 +612,8 @@ paths:
           description: Database can't process request.
         "500":
           $ref: "#/components/responses/ServiceError"
-  
-  /{domainID}/clients/{clientID}/roles/{roleName}/actions:
+
+  /{domainID}/clients/{clientID}/roles/{roleID}/actions:
     post:
       operationId: addClientRoleAction
       summary: Adds a role action for a client role.
@@ -624,7 +624,7 @@ paths:
       parameters:
         - $ref: "auth.yml#/components/parameters/DomainID"
         - $ref: "#/components/parameters/clientID"
-        - $ref: "./schemas/roles.yml#/components/parameters/RoleName"
+        - $ref: "./schemas/roles.yml#/components/parameters/RoleID"
       requestBody:
         $ref: "./schemas/roles.yml#/components/requestBodies/AddRoleActionsReq"
       security:
@@ -645,18 +645,18 @@ paths:
           description: Database can't process request.
         "500":
           $ref: "#/components/responses/ServiceError"
-  
+
     get:
       operationId: listClientRoleActions
       tags:
         - Roles
       summary: Lists client role actions.
       description: |
-        Retrieves a list of client role actions. 
+        Retrieves a list of client role actions.
       parameters:
         - $ref: "auth.yml#/components/parameters/DomainID"
         - $ref: "#/components/parameters/clientID"
-        - $ref: "./schemas/roles.yml#/components/parameters/RoleName"
+        - $ref: "./schemas/roles.yml#/components/parameters/RoleID"
       security:
         - bearerAuth: []
       responses:
@@ -675,8 +675,8 @@ paths:
           description: Database can't process request.
         "500":
           $ref: "#/components/responses/ServiceError"
-  
-  /{domainID}/clients/{clientID}/roles/{roleName}/actions/delete:
+
+  /{domainID}/clients/{clientID}/roles/{roleID}/actions/delete:
     post:
       operationId: deleteClientRoleAction
       summary: Deletes role actions for a client role.
@@ -687,7 +687,7 @@ paths:
       parameters:
         - $ref: "auth.yml#/components/parameters/DomainID"
         - $ref: "#/components/parameters/clientID"
-        - $ref: "./schemas/roles.yml#/components/parameters/RoleName"
+        - $ref: "./schemas/roles.yml#/components/parameters/RoleID"
       requestBody:
         $ref: "./schemas/roles.yml#/components/requestBodies/AddRoleActionsReq"
       security:
@@ -708,8 +708,8 @@ paths:
           description: Database can't process request.
         "500":
           $ref: "#/components/responses/ServiceError"
-    
-  /{domainID}/clients/{clientID}/roles/{roleName}/actions/delete-all:
+
+  /{domainID}/clients/{clientID}/roles/{roleID}/actions/delete-all:
     post:
       operationId: deleteAllClientRoleActions
       summary: Deletes all role actions for a client role.
@@ -720,7 +720,7 @@ paths:
       parameters:
         - $ref: "auth.yml#/components/parameters/DomainID"
         - $ref: "#/components/parameters/clientID"
-        - $ref: "./schemas/roles.yml#/components/parameters/RoleName"
+        - $ref: "./schemas/roles.yml#/components/parameters/RoleID"
       security:
         - bearerAuth: []
       responses:
@@ -739,8 +739,8 @@ paths:
           description: Database can't process request.
         "500":
           $ref: "#/components/responses/ServiceError"
-  
-  /{domainID}/clients/{clientID}/roles/{roleName}/members:
+
+  /{domainID}/clients/{clientID}/roles/{roleID}/members:
     post:
       operationId: addClientRoleMember
       summary: Adds a member to a client role.
@@ -751,7 +751,7 @@ paths:
       parameters:
         - $ref: "auth.yml#/components/parameters/DomainID"
         - $ref: "#/components/parameters/clientID"
-        - $ref: "./schemas/roles.yml#/components/parameters/RoleName"
+        - $ref: "./schemas/roles.yml#/components/parameters/RoleID"
       requestBody:
         $ref: "./schemas/roles.yml#/components/requestBodies/AddRoleMembersReq"
       security:
@@ -772,18 +772,18 @@ paths:
           description: Database can't process request.
         "500":
           $ref: "#/components/responses/ServiceError"
-    
+
     get:
       operationId: listClientRoleMembers
       tags:
         - Roles
       summary: Lists client role members.
       description: |
-        Retrieves a list of client role members. 
+        Retrieves a list of client role members.
       parameters:
         - $ref: "auth.yml#/components/parameters/DomainID"
         - $ref: "#/components/parameters/clientID"
-        - $ref: "./schemas/roles.yml#/components/parameters/RoleName"
+        - $ref: "./schemas/roles.yml#/components/parameters/RoleID"
       security:
         - bearerAuth: []
       responses:
@@ -802,8 +802,8 @@ paths:
           description: Database can't process request.
         "500":
           $ref: "#/components/responses/ServiceError"
-    
-  /{domainID}/clients/{clientID}/roles/{roleName}/members/delete:
+
+  /{domainID}/clients/{clientID}/roles/{roleID}/members/delete:
     post:
       operationId: deleteClientRoleMembers
       summary: Deletes members from a client role.
@@ -814,7 +814,7 @@ paths:
       parameters:
         - $ref: "auth.yml#/components/parameters/DomainID"
         - $ref: "#/components/parameters/clientID"
-        - $ref: "./schemas/roles.yml#/components/parameters/RoleName"
+        - $ref: "./schemas/roles.yml#/components/parameters/RoleID"
       requestBody:
         $ref: "./schemas/roles.yml#/components/requestBodies/AddRoleMembersReq"
       security:
@@ -835,8 +835,8 @@ paths:
           description: Database can't process request.
         "500":
           $ref: "#/components/responses/ServiceError"
-  
-  /{domainID}/clients/{clientID}/roles/{roleName}/members/delete-all:
+
+  /{domainID}/clients/{clientID}/roles/{roleID}/members/delete-all:
     post:
       operationId: deleteAllClientRoleMembers
       summary: Deletes all members from a client role.
@@ -847,7 +847,7 @@ paths:
       parameters:
         - $ref: "auth.yml#/components/parameters/DomainID"
         - $ref: "#/components/parameters/clientID"
-        - $ref: "./schemas/roles.yml#/components/parameters/RoleName"
+        - $ref: "./schemas/roles.yml#/components/parameters/RoleID"
       security:
         - bearerAuth: []
       responses:
@@ -874,7 +874,7 @@ paths:
         - Roles
       summary: Retrieves available actions.
       description: |
-        Retrieves a list of available actions. 
+        Retrieves a list of available actions.
       parameters:
         - $ref: "auth.yml#/components/parameters/DomainID"
       security: