Skip to content

Commit 658eaa0

Browse files
committed
docs(backend/shared): Update typedoc comments
1 parent f47b5a3 commit 658eaa0

File tree

5 files changed

+10
-10
lines changed

5 files changed

+10
-10
lines changed

packages/backend/src/api/endpoints/InstanceApi.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ type UpdateOrganizationSettingsParams = {
5252
adminDeleteEnabled?: boolean | null | undefined;
5353
domainsEnabled?: boolean | null | undefined;
5454
/**
55-
* Specifies which [enrollment modes](https://clerk.com/docs/guides/organizations/verified-domains#enrollment-mode) to enable for your Organization Domains.
55+
* Specifies which [enrollment modes](https://clerk.com/docs/guides/organizations/add-members/verified-domains#enrollment-mode) to enable for your Organization Domains.
5656
*
5757
* @remarks Supported modes are 'automatic_invitation' & 'automatic_suggestion'.
5858
*/

packages/shared/src/react/hooks/useOrganization.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export type UseOrganizationParams = {
2929
* If set to `true`, all default properties will be used.<br />
3030
* Otherwise, accepts an object with the following optional properties:
3131
* <ul>
32-
* <li>`enrollmentMode`: A string that filters the domains by the provided [enrollment mode](https://clerk.com/docs/guides/organizations/verified-domains#enrollment-mode).</li>
32+
* <li>`enrollmentMode`: A string that filters the domains by the provided [enrollment mode](https://clerk.com/docs/guides/organizations/add-members/verified-domains#enrollment-mode).</li>
3333
* <li>Any of the properties described in [Shared properties](#shared-properties).</li>
3434
* </ul>
3535
*/

packages/shared/src/types/organization.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ declare global {
3131
/**
3232
* The `Organization` object holds information about an organization, as well as methods for managing it.
3333
*
34-
* To use these methods, you must have the **Organizations** feature [enabled in your app's settings in the Clerk Dashboard](https://clerk.com/docs/guides/organizations/overview#enable-organizations-in-your-application).
34+
* To use these methods, you must have the **Organizations** feature [enabled in your app's settings in the Clerk Dashboard](https://clerk.com/docs/guides/organizations/configure#enable-organizations).
3535
*
3636
* @interface
3737
*/

packages/shared/src/types/organizationMembership.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ export type OrganizationCustomPermissionKey = ClerkAuthorization extends Placeho
7070
/**
7171
* `OrganizationCustomRoleKey` is a type that represents the user's role in an organization. It will be string unless the developer has provided their own types through [`ClerkAuthorization`](https://clerk.com/docs/guides/development/override-clerk-types-interfaces#example-custom-roles-and-permissions).
7272
*
73-
* Clerk provides the [default roles](https://clerk.com/docs/guides/organizations/roles-and-permissions#default-roles) `org:admin` and `org:member`. However, you can create [custom roles](https://clerk.com/docs/guides/organizations/roles-and-permissions#custom-roles) as well.
73+
* Clerk provides the [default roles](https://clerk.com/docs/guides/organizations/control-access/roles-and-permissions#default-roles) `org:admin` and `org:member`. However, you can create [custom roles](https://clerk.com/docs/guides/organizations/control-access/roles-and-permissions#custom-roles) as well.
7474
*
7575
* @interface
7676
*/

packages/shared/src/types/session.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -61,11 +61,11 @@ type WithReverification<T> = T & {
6161
export type CheckAuthorizationParamsWithCustomPermissions = WithReverification<
6262
| {
6363
/**
64-
* The [role](https://clerk.com/docs/guides/organizations/roles-and-permissions) to check for.
64+
* The [role](https://clerk.com/docs/guides/organizations/control-access/roles-and-permissions) to check for.
6565
*/
6666
role: OrganizationCustomRoleKey;
6767
/**
68-
* The [permission](https://clerk.com/docs/guides/organizations/roles-and-permissions) to check for.
68+
* The [permission](https://clerk.com/docs/guides/organizations/control-access/roles-and-permissions) to check for.
6969
*/
7070
permission?: never;
7171
/**
@@ -103,11 +103,11 @@ export type CheckAuthorization = CheckAuthorizationFn<CheckAuthorizationParams>;
103103
type CheckAuthorizationParams = WithReverification<
104104
| {
105105
/**
106-
* The [role](https://clerk.com/docs/guides/organizations/roles-and-permissions) to check for.
106+
* The [role](https://clerk.com/docs/guides/organizations/control-access/roles-and-permissions) to check for.
107107
*/
108108
role: OrganizationCustomRoleKey;
109109
/**
110-
* The [permission](https://clerk.com/docs/guides/organizations/roles-and-permissions) to check for.
110+
* The [permission](https://clerk.com/docs/guides/organizations/control-access/roles-and-permissions) to check for.
111111
*/
112112
permission?: never;
113113
/**
@@ -155,11 +155,11 @@ export type CheckAuthorizationFromSessionClaims = <P extends OrganizationCustomP
155155
export type CheckAuthorizationParamsFromSessionClaims<P extends OrganizationCustomPermissionKey> = WithReverification<
156156
| {
157157
/**
158-
* The [role](https://clerk.com/docs/guides/organizations/roles-and-permissions) to check for.
158+
* The [role](https://clerk.com/docs/guides/organizations/control-access/roles-and-permissions) to check for.
159159
*/
160160
role: OrganizationCustomRoleKey;
161161
/**
162-
* The [permission](https://clerk.com/docs/guides/organizations/roles-and-permissions) to check for.
162+
* The [permission](https://clerk.com/docs/guides/organizations/control-access/roles-and-permissions) to check for.
163163
*/
164164
permission?: never;
165165
/**

0 commit comments

Comments
 (0)