Skip to content

Commit 400f083

Browse files
committed
docs(okta): use TSDoc for the new block annotations
1 parent 3833884 commit 400f083

2 files changed

Lines changed: 15 additions & 11 deletions

File tree

apps/sim/blocks/blocks/okta.ts

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -294,10 +294,12 @@ export const OktaBlock: BlockConfig<OktaResponse> = {
294294
},
295295
},
296296
{
297-
// Group rules take a plain keyword on `search`, not the SCIM-style
298-
// expression the Search field's wand generates, so they get their own
299-
// field rather than sharing one that would produce a silently
300-
// non-matching query.
297+
/**
298+
* Group rules take a plain keyword on `search`, not the SCIM-style
299+
* expression the Search field's wand generates, so they get their own
300+
* field rather than sharing one that would produce a silently
301+
* non-matching query.
302+
*/
301303
id: 'ruleSearch',
302304
title: 'Search',
303305
type: 'short-input',
@@ -485,7 +487,7 @@ export const OktaBlock: BlockConfig<OktaResponse> = {
485487
placeholder: 'Description for the group',
486488
condition: { field: 'operation', value: ['okta_create_group', 'okta_update_group'] },
487489
},
488-
/*
490+
/**
489491
* Okta's `sendEmail` default is not uniform: activation and password reset
490492
* default to sending, deactivation and removal default to not sending. One
491493
* shared switch could only be seeded for one of those, so the two groups get
@@ -684,8 +686,10 @@ export const OktaBlock: BlockConfig<OktaResponse> = {
684686
id: 'forgetDevices',
685687
title: 'Forget Devices',
686688
type: 'switch',
687-
// Okta defaults this to true, so an unseeded switch would render off while
688-
// remembered factors were in fact being cleared.
689+
/**
690+
* Okta defaults this to true, so an unseeded switch would render off while
691+
* remembered factors were in fact being cleared.
692+
*/
689693
value: () => 'true',
690694
condition: { field: 'operation', value: 'okta_clear_user_sessions' },
691695
mode: 'advanced',
@@ -974,15 +978,15 @@ export const OktaBlock: BlockConfig<OktaResponse> = {
974978
domain: params.domain,
975979
limit: toFiniteNumber(params.limit),
976980
priority: toFiniteNumber(params.priority),
977-
// Group-specific UI fields carry the tool's generic param names.
981+
/** Group-specific UI fields carry the tool's generic param names. */
978982
name: blankToUndefined(params.groupName),
979983
description: blankToUndefined(params.groupDescription),
980-
// Group rules get their own keyword field but the same wire param.
984+
/** Group rules get their own keyword field but the same wire param. */
981985
search:
982986
params.operation === 'okta_list_group_rules'
983987
? blankToUndefined(params.ruleSearch)
984988
: blankToUndefined(params.search),
985-
/*
989+
/**
986990
* Keyed off the operation rather than `??`: both switches are advanced,
987991
* and `shouldSerializeSubBlock` skips `condition` for advanced fields,
988992
* so a stale value from a previously selected operation can still be

apps/sim/tools/okta/get_logs.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ export const oktaGetLogsTool: ToolConfig<OktaGetLogsParams, OktaGetLogsResponse>
8484
if (params.q) queryParams.append('q', params.q)
8585
if (params.sortOrder) queryParams.append('sortOrder', params.sortOrder)
8686
if (params.after) queryParams.append('after', params.after)
87-
// `0` is a documented limit on this endpoint, so it must not be treated as absent.
87+
/** `0` is a documented limit on this endpoint, so it must not read as absent. */
8888
if (params.limit !== undefined && params.limit !== null) {
8989
queryParams.append('limit', params.limit.toString())
9090
}

0 commit comments

Comments
 (0)