docs: adding docs to query hook and removing todo

Author: jacobo-dominguez-wgu

src/authz-module/data/api.ts

@@ -118,9 +118,6 @@ export const revokeUserRoles = async (
 
 export const getUserAssignedRoles = async (username: string, querySettings: QuerySettings)
 : Promise<GetUserAssignmentsResponse> => {
-  // TODO: this endpoint is expected to retrieve the roles assigned to a user
-  // corroborate the endpoint is correct
-  // /api/authz/v1/users/(user_id)/assignments/
   const url = new URL(getApiUrl(`/api/authz/v1/users/${username}/assignments/`));
 
   if (querySettings.roles) {

src/authz-module/data/hooks.ts

@@ -113,6 +113,17 @@ export const useRevokeUserRoles = () => {
   });
 };
 
+/*
+  * React Query hook to fetch all the roles assigned to a specific user.
+  * It retrieves the full list of roles with the corresponding permissions.
+  * @param username - The username of the user
+  * @param querySettings - Optional query parameters for filtering, sorting, and pagination
+  *
+  * @example
+  * ```tsx
+  * const { data: userRoles } = useUserAssignedRoles('jdoe', querySettings);
+  * ```
+*/
 export const useUserAssignedRoles = (username: string, querySettings: QuerySettings) => {
   const result = useQuery<GetUserAssignmentsResponse, Error>({
     queryKey: authzQueryKeys.userRoles(username, querySettings),