add documentation

Author: ekraffmiller

docs/useCases.md

@@ -75,6 +75,9 @@ The different use cases currently available in the package are classified below,
     - [Delete Current API Token](#delete-current-api-token)
     - [Recreate Current API Token](#recreate-current-api-token)
     - [Register User](#register-user)
+- [Roles](#Roles)
+  - [Roles read use cases](#roles-read-use-cases)
+    - [Get User Selectable Roles](#get-user-selectable-roles)
 - [Info](#Info)
   - [Get Dataverse Backend Version](#get-dataverse-backend-version)
   - [Get Maximum Embargo Duration In Months](#get-maximum-embargo-duration-in-months)
@@ -1842,6 +1845,28 @@ registerUser.execute(userDTO)
 
 _See [use case](../src/users/domain/useCases/RegisterUser.ts) implementation_.
 
+## Roles
+
+### Get User Selectable Roles
+
+Returns a [Role](../src/roles/domain/models/Role.ts) array that the calling user can use as filters when searching within their data.
+
+##### Example call:
+
+```typescript
+import { getUserSelectableRoles } from '@iqss/dataverse-client-javascript'
+
+/* ... */
+
+getUserSelectableRoles.execute().then((roles: Role[]) => {
+  /* ... */
+})
+
+/* ... */
+```
+
+_See [use case](../src/roles/domain/useCases/GetUserSelectableRoles.ts) implementation_.
+
 ## Info
 
 #### Get Dataverse Backend Version

src/roles/domain/useCases/GetUserSelectableRoles.ts

@@ -6,9 +6,9 @@ export class GetUserSelectableRoles implements UseCase<Role[]> {
   constructor(private readonly rolesRepository: IRolesRepository) {}
 
   /**
-   * Returns an array of Roles, for the currently logged in user.
+   * Returns the appropriate roles that the calling user can use as filters when searching within their data.
    *
-   * @returns {Promise<Role[]>} - A promise that resolves to an array of Role instances that the user can select.
+   * @returns {Promise<Role[]>} - A promise that resolves to an array of Role instances.
    */
   async execute(): Promise<Role[]> {
     return (await this.rolesRepository.getUserSelectableRoles()) as Role[]