Skip to content

Commit 07e90c1

Browse files
alexisintechclaude
andauthored
docs(shared): fix broken Clerk docs links in organization JSDoc (#8825)
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent b7cac0a commit 07e90c1

5 files changed

Lines changed: 8 additions & 8 deletions

File tree

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
---
2+
---

packages/shared/src/types/billing.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -157,9 +157,7 @@ export type GetPlansParams = ClerkPaginationParams<{
157157
*/
158158
for?: ForPayerType;
159159
/**
160-
* The organization ID to fetch plans for (needs to match the current active organization ID). Providing this
161-
* parameter will populate the `availablePrices` field with the prices that are available to the
162-
* authenticated organization.
160+
* The organization ID to fetch plans for (needs to match the current [Active Organization](!active-organization) ID). Providing this parameter will populate the `availablePrices` field with the prices that are available to the authenticated organization.
163161
*/
164162
orgId?: string;
165163
/**

packages/shared/src/types/organizationDomain.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ export interface OrganizationDomainResource extends ClerkResource {
5454
*
5555
* <ul>
5656
* <li>`manual_invitation`: No automatic enrollment. Users with a matching email domain are not given any [invitation](https://clerk.com/docs/guides/organizations/add-members/verified-domains#automatic-invitations) or [suggestion](https://clerk.com/docs/guides/organizations/add-members/verified-domains#automatic-suggestions); an admin must invite them manually.</li>
57-
* <li>`automatic_invitation`: Users with a matching email domain automatically receive a pending [invitation](https://clerk.com/docs/reference/types/organizationinvitation) (assigned the Organization's default role) which they can accept to join.</li>
57+
* <li>`automatic_invitation`: Users with a matching email domain automatically receive a pending [invitation](https://clerk.com/docs/reference/types/organization-invitation) (assigned the Organization's default role) which they can accept to join.</li>
5858
* <li>`automatic_suggestion`: Users with a matching email domain automatically receive a [suggestion](https://clerk.com/docs/guides/organizations/add-members/verified-domains#automatic-suggestions) to join, which they can request.</li>
5959
* </ul>
6060
*/
@@ -76,7 +76,7 @@ export interface OrganizationDomainResource extends ClerkResource {
7676
*/
7777
affiliationEmailAddress: string | null;
7878
/**
79-
* The total number of pending [invitations](https://clerk.com/docs/reference/types/organizationinvitation) associated with this domain.
79+
* The total number of pending [invitations](https://clerk.com/docs/reference/types/organization-invitation) associated with this domain.
8080
*/
8181
totalPendingInvitations: number;
8282
/**
@@ -132,7 +132,7 @@ export type AttemptAffiliationVerificationParams = {
132132
/** @generateWithEmptyComment */
133133
export type UpdateEnrollmentModeParams = Pick<OrganizationDomainResource, 'enrollmentMode'> & {
134134
/**
135-
* Whether to delete any pending [invitations](https://clerk.com/docs/reference/types/organizationinvitation) or [suggestions](https://clerk.com/docs/reference/types/organizationsuggestion) that were created by the previous enrollment mode.
135+
* Whether to delete any pending [invitations](https://clerk.com/docs/reference/types/organization-invitation) or [suggestions](https://clerk.com/docs/reference/types/organization-suggestion) that were created by the previous enrollment mode.
136136
*/
137137
deletePending?: boolean;
138138
};

packages/shared/src/types/organizationMembership.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ export interface OrganizationMembershipResource extends ClerkResource {
4646
*/
4747
id: string;
4848
/**
49-
* The [`Organization`](https://clerk.com/docs/reference/types/organization) object the membership belongs to.
49+
* The [`Organization`](https://clerk.com/docs/reference/objects/organization) object the membership belongs to.
5050
*/
5151
organization: OrganizationResource;
5252
/**

packages/shared/src/types/organizationSettings.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ export interface OrganizationSettingsResource extends ClerkResource {
6565
*
6666
* <ul>
6767
* <li>`manual_invitation`: No automatic enrollment. Users with a matching email domain are not given any [invitation](https://clerk.com/docs/guides/organizations/add-members/verified-domains#automatic-invitations) or [suggestion](https://clerk.com/docs/guides/organizations/add-members/verified-domains#automatic-suggestions); an admin must invite them manually.</li>
68-
* <li>`automatic_invitation`: Users with a matching email domain automatically receive a pending [invitation](https://clerk.com/docs/reference/types/organizationinvitation) (assigned the Organization's default role) which they can accept to join.</li>
68+
* <li>`automatic_invitation`: Users with a matching email domain automatically receive a pending [invitation](https://clerk.com/docs/reference/types/organization-invitation) (assigned the Organization's default role) which they can accept to join.</li>
6969
* <li>`automatic_suggestion`: Users with a matching email domain automatically receive a [suggestion](https://clerk.com/docs/guides/organizations/add-members/verified-domains#automatic-suggestions) to join, which they can request.</li>
7070
* </ul>
7171
*/

0 commit comments

Comments
 (0)