Skip to content

Commit 4c64058

Browse files
committed
Fix jsdocs
Jira ticket: CAMS-283
1 parent 213d878 commit 4c64058

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

backend/functions/lib/adapters/gateways/okta/okta-user-group-gateway.ts

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,11 @@ function validateConfiguration(config: UserGroupGatewayConfig): void {
3636
* Creates an Okta Client instance and retains it in module scope as a singleton.
3737
* Subsequent calls to initialize return the previously created instance.
3838
*
39-
* See: https://github.com/okta/okta-sdk-nodejs?tab=readme-ov-file#oauth-20-authentication
40-
* See: https://github.com/okta/okta-sdk-nodejs?tab=readme-ov-file#known-issues
39+
* @see https://github.com/okta/okta-sdk-nodejs?tab=readme-ov-file#oauth-20-authentication
40+
* @see https://github.com/okta/okta-sdk-nodejs?tab=readme-ov-file#known-issues
4141
*
42-
* @param config UserGroupGatewayConfig
43-
* @returns
42+
* @param {UserGroupGatewayConfig} config
43+
* @returns {Client}
4444
*/
4545
export async function initialize(config: UserGroupGatewayConfig): Promise<Client> {
4646
validateConfiguration(config);
@@ -67,12 +67,12 @@ export async function initialize(config: UserGroupGatewayConfig): Promise<Client
6767
*
6868
* Retrieves a list of Okta groups and transforms them into a list of CamsUserGroup.
6969
*
70-
* See: https://github.com/okta/okta-sdk-nodejs?tab=readme-ov-file#groups
71-
* See: https://developer.okta.com/docs/api/
72-
* See: https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Group/#tag/Group/operation/listGroups
70+
* @see https://github.com/okta/okta-sdk-nodejs?tab=readme-ov-file#groups
71+
* @see https://developer.okta.com/docs/api/
72+
* @see https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Group/#tag/Group/operation/listGroups
7373
*
74-
* @param config UserGroupGatewayConfig
75-
* @returns CamsUserGroup[]
74+
* @param {UserGroupGatewayConfig} config
75+
* @returns {CamsUserGroup[]}
7676
*/
7777
async function getUserGroups(config: UserGroupGatewayConfig): Promise<CamsUserGroup[]> {
7878
const camsUserGroups: CamsUserGroup[] = [];
@@ -101,13 +101,13 @@ async function getUserGroups(config: UserGroupGatewayConfig): Promise<CamsUserGr
101101
* Retrieves a list of Okta users for a given Okta group and transforms them
102102
* into a list of CamsUserReference.
103103
*
104-
* See: https://github.com/okta/okta-sdk-nodejs?tab=readme-ov-file#groups
105-
* See: https://developer.okta.com/docs/api/
106-
* See: https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Group/#tag/Group/operation/listGroupUsers
104+
* @see https://github.com/okta/okta-sdk-nodejs?tab=readme-ov-file#groups
105+
* @see https://developer.okta.com/docs/api/
106+
* @see https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Group/#tag/Group/operation/listGroupUsers
107107
*
108-
* @param config UserGroupGatewayConfig
109-
* @param group CamsUserGroup
110-
* @returns CamsUserReference[]
108+
* @param {UserGroupGatewayConfig} config
109+
* @param {CamsUserGroup} group
110+
* @returns {CamsUserReference[]}
111111
*/
112112
async function getUserGroupUsers(
113113
config: UserGroupGatewayConfig,

0 commit comments

Comments
 (0)