(chore) update prop/param descriptions to be consistent (#1824)

Co-authored-by: victoria <[email protected]>
clerk · Dec 18, 2024 · 0fdc7d0 · 0fdc7d0
1 parent 979b9d7
commit 0fdc7d0
Show file tree

Hide file tree

Showing 63 changed files with 285 additions and 204 deletions.
diff --git a/docs/references/astro/auth-store.mdx b/docs/references/astro/auth-store.mdx
@@ -11,21 +11,21 @@ The `$authStore` store provides a convenient way to access the current auth stat
   - `userId`
   - `string`
 
-  The unique identifier of the current user.
+  The ID of the current user.
 
   ---
 
   - `sessionId`
   - `string`
 
-  The unique identifier of the current session.
+  The ID of the current session.
 
   ---
 
   - `orgId`
   - `string`
 
-  The unique identifier of the user's active organization.
+  The ID of the user's active organization.
 
   ---
 

diff --git a/docs/references/backend/email-addresses/create-email-address.mdx b/docs/references/backend/email-addresses/create-email-address.mdx
@@ -17,7 +17,7 @@ function createEmailAddress(params: CreateEmailAddressParams): Promise<EmailAddr
   - `userId`
   - `string`
 
-  The unique identifier of the user to create the email address for.
+  The ID of the user to create the email address for.
 
   ---
 

diff --git a/docs/references/backend/invitations/create-invitation.mdx b/docs/references/backend/invitations/create-invitation.mdx
@@ -31,7 +31,7 @@ function createInvitation(params: CreateParams): Promise<Invitation>
   ---
 
   - `publicMetadata?`
-  - `{[string]: any}`
+  - [`UserPublicMetadata`](/docs/references/javascript/types/metadata#user-public-metadata)
 
   Metadata that can be read from both the Frontend API and [Backend API](/docs/reference/backend-api){{ target: '_blank' }}, but can be set only from the Backend API. Once the user accepts the invitation and signs up, these metadata will end up in the user's public metadata.
 

diff --git a/docs/references/backend/organization/create-organization-invitation.mdx b/docs/references/backend/organization/create-organization-invitation.mdx
@@ -52,9 +52,9 @@ function createOrganizationInvitation(
   ---
 
   - `publicMetadata?`
-  - `{[string]: any}`
+  - [`OrganizationInvitationPublicMetadata`](/docs/references/javascript/types/metadata#organization-invitation-public-metadata)
 
-  Metadata that can be read from both the Frontend API and [Backend API](/docs/reference/backend-api){{ target: '_blank' }}, but can be set only from the Backend API .
+  Metadata that can be read from both the Frontend API and [Backend API](/docs/reference/backend-api){{ target: '_blank' }}, but can be set only from the Backend API.
 </Properties>
 
 ## Example

diff --git a/docs/references/backend/organization/create-organization-membership.mdx b/docs/references/backend/organization/create-organization-membership.mdx
@@ -19,14 +19,14 @@ function createOrganizationMembership(
   - `organizationId`
   - `string`
 
-  The organization ID of the organization a user is being added to.
+  The ID of the organization the user is being added to.
 
   ---
 
   - `userId`
   - `string`
 
-  The unique identifier of the user to be added to the organization.
+  The ID of the user to be added to the organization.
 
   ---
 

diff --git a/docs/references/backend/organization/create-organization.mdx b/docs/references/backend/organization/create-organization.mdx
@@ -36,14 +36,14 @@ function createOrganization(params: CreateParams): Promise<Organization>
   ---
 
   - `publicMetadata?`
-  - `{[string]: any}`
+  - [`OrganizationPublicMetadata`](/docs/references/javascript/types/metadata#organization-public-metadata)
 
-  Metadata that can be read from both the Frontend API and [Backend API](/docs/reference/backend-api){{ target: '_blank' }}, but can be set only from the Backend API .
+  Metadata that can be read from both the Frontend API and [Backend API](/docs/reference/backend-api){{ target: '_blank' }}, but can be set only from the Backend API.
 
   ---
 
   - `privateMetadata?`
-  - `{[string]: any}`
+  - [`OrganizationPrivateMetadata`](/docs/references/javascript/types/metadata#organization-private-metadata)
 
   Metadata that is only visible to your [Backend API](/docs/reference/backend-api){{ target: '_blank' }}.
 

diff --git a/docs/references/backend/organization/delete-organization-membership.mdx b/docs/references/backend/organization/delete-organization-membership.mdx
@@ -26,7 +26,7 @@ function getOrganizationList(
   - `userId`
   - `string`
 
-  The unique identifier of the user to be removed from the organization.
+  The ID of the user to be removed from the organization.
 </Properties>
 
 ## Example

diff --git a/docs/references/backend/organization/update-organization-membership-metadata.mdx b/docs/references/backend/organization/update-organization-membership-metadata.mdx
@@ -26,19 +26,19 @@ function updateOrganizationMembershipMetadata(
   - `userId`
   - `string`
 
-  The unique identifier of the user that this membership belongs to.
+  The ID of the user that this membership belongs to.
 
   ---
 
   - `publicMetadata?`
-  - `{[string]: any}`
+  - [`OrganizationMembershipPublicMetadata`](/docs/references/javascript/types/metadata#organization-membership-public-metadata)
 
-  Metadata that can be read from both the Frontend API and [Backend API](/docs/reference/backend-api){{ target: '_blank' }}, but can be set only from the Backend API .
+  Metadata that can be read from both the Frontend API and [Backend API](/docs/reference/backend-api){{ target: '_blank' }}, but can be set only from the Backend API.
 
   ---
 
   - `privateMetadata?`
-  - `{[string]: any}`
+  - [`OrganizationMembershipPrivateMetadata`](/docs/references/javascript/types/metadata#organization-membership-private-metadata)
 
   Metadata that is only visible to your [Backend API](/docs/reference/backend-api){{ target: '_blank' }}.
 </Properties>

diff --git a/docs/references/backend/organization/update-organization-membership.mdx b/docs/references/backend/organization/update-organization-membership.mdx
@@ -19,14 +19,14 @@ function updateOrganizationMembership(
   - `organizationId`
   - `string`
 
-  The organization ID of the organization a user belongs to.
+  The ID of the organization this membership belongs to.
 
   ---
 
   - `userId`
   - `string`
 
-  The unique identifier of the user to update.
+  The ID of the user that this membership belongs to.
 
   ---
 

diff --git a/docs/references/backend/organization/update-organization-metadata.mdx b/docs/references/backend/organization/update-organization-metadata.mdx
@@ -25,14 +25,14 @@ function updateOrganizationMetadata(
   ---
 
   - `publicMetadata?`
-  - `{[string]: any}`
+  - [`OrganizationPublicMetadata`](/docs/references/javascript/types/metadata#organization-public-metadata)
 
   Metadata that can be read from both the Frontend API and [Backend API](/docs/reference/backend-api){{ target: '_blank' }}, but can be set only from the Backend API .
 
   ---
 
   - `privateMetadata?`
-  - `{[string]: any}`
+  - [`OrganizationPrivateMetadata`](/docs/references/javascript/types/metadata#organization-private-metadata)
 
   Metadata that is only visible to your [Backend API](/docs/reference/backend-api){{ target: '_blank' }}.
 </Properties>

diff --git a/docs/references/backend/organization/update-organization.mdx b/docs/references/backend/organization/update-organization.mdx
@@ -34,16 +34,16 @@ function updateOrganization(params: UpdateOrganizationParams): Promise<Organizat
   ---
 
   - `publicMetadata?`
-  - `{[string]: any}`
+  - [`OrganizationPublicMetadata`](/docs/references/javascript/types/metadata#organization-public-metadata)
 
-  Metadata that can be read from both the Frontend API and [Backend API](/docs/reference/backend-api){{ target: '_blank' }}, but can be set only from the Backend API .
+  Metadata that can be read from both the Frontend API and [Backend API](/docs/reference/backend-api){{ target: '_blank' }}, but can be set only from the Backend API. Updating this property will override the existing metadata. To merge metadata, use [`updateOrganizationMetadata()`](/docs/references/backend/organization/update-organization-metadata).
 
   ---
 
   - `privateMetadata?`
-  - `{[string]: any}`
+  - [`OrganizationPrivateMetadata`](/docs/references/javascript/types/metadata#organization-private-metadata)
 
-  Metadata that is only visible to your [Backend API](/docs/reference/backend-api){{ target: '_blank' }}.
+  Metadata that is only visible to your [Backend API](/docs/reference/backend-api){{ target: '_blank' }}. Updating this property will override the existing metadata. To merge metadata, use [`updateOrganizationMetadata()`](/docs/references/backend/organization/update-organization-metadata).
 
   ---
 

diff --git a/docs/references/backend/phone-numbers/create-phone-number.mdx b/docs/references/backend/phone-numbers/create-phone-number.mdx
@@ -17,7 +17,7 @@ function createPhoneNumber(params: CreatePhoneNumberParams): Promise<PhoneNumber
   - `userId`
   - `string`
 
-  The unique identifier of the user to create the phone number for.
+  The ID of the user to create the phone number for.
 
   ---
 

diff --git a/docs/references/backend/sessions/get-session.mdx b/docs/references/backend/sessions/get-session.mdx
@@ -17,7 +17,7 @@ function getSession(sessionId: string): Promise<Session>
   - `sessionId`
   - `string`
 
-  The unique identifier of the session to retrieve.
+  The ID of the session to retrieve.
 </Properties>
 
 ## Example

diff --git a/docs/references/backend/sessions/get-token.mdx b/docs/references/backend/sessions/get-token.mdx
@@ -17,7 +17,7 @@ function getToken(sessionId: string, template: string): Promise<Token>
   - `sessionId`
   - `string`
 
-  The unique identifier of the session to retrieve a token for.
+  The ID of the session to retrieve a token for.
 
   ---
 

diff --git a/docs/references/backend/sessions/revoke-session.mdx b/docs/references/backend/sessions/revoke-session.mdx
@@ -19,7 +19,7 @@ function revokeSession(sessionId: string): Promise<Session>
   - `sessionId`
   - `string`
 
-  The unique identifier of the session to revoke.
+  The ID of the session to revoke.
 </Properties>
 
 ## Example

diff --git a/docs/references/backend/sessions/verify-session.mdx b/docs/references/backend/sessions/verify-session.mdx
@@ -27,7 +27,7 @@ const session = await clerkClient.sessions.verifySession(sessionId, token)
   - `sessionId`
   - `string`
 
-  The unique identifier of the session to verify.
+  The ID of the session to verify.
 
   ---
 

diff --git a/docs/references/backend/sign-in-tokens/create-sign-in-token.mdx b/docs/references/backend/sign-in-tokens/create-sign-in-token.mdx
@@ -15,7 +15,7 @@ function createSignInToken(params: CreateSignInTokensParams): Promise<SignInToke
   - `userId`
   - `string`
 
-  The unique identifier of the user who can use the newly created sign-in token.
+  The ID of the user who can use the newly created sign-in token.
 
   ---
 

diff --git a/docs/references/backend/types/backend-allowlist-identifier.mdx b/docs/references/backend/types/backend-allowlist-identifier.mdx
@@ -25,14 +25,14 @@ The Backend `AllowlistIdentifier` object represents an identifier that has been
   - `createdAt`
   - `number`
 
-  Date when the allowlist identifier was first created.
+  The date when the allowlist identifier was first created.
 
   ---
 
   - `updatedAt`
   - `number`
 
-  Date of the last time the allowlist identifier was updated.
+  The date when the allowlist identifier was last updated.
 
   ---
 

diff --git a/docs/references/backend/types/backend-client.mdx b/docs/references/backend/types/backend-client.mdx
@@ -11,7 +11,7 @@ The Backend `Client` object is similar to the [`Client`](/docs/references/javasc
   - `id`
   - `string`
 
-  A unique identifier for the client.
+  The unique identifier for the `Client`.
 
   ---
 
@@ -53,12 +53,12 @@ The Backend `Client` object is similar to the [`Client`](/docs/references/javasc
   - `createdAt`
   - `number`
 
-  Date when the `Client` was first created.
+  The date when the `Client` was first created.
 
   ---
 
   - `updatedAt`
   - `number`
 
-  Date of the last time the `Client` was updated.
+  The date when the `Client` was last updated.
 </Properties>
diff --git a/docs/references/backend/types/backend-invitation.mdx b/docs/references/backend/types/backend-invitation.mdx
@@ -11,7 +11,7 @@ The Backend `Invitation` object represents an invitation to join your applicatio
   - `id`
   - `string`
 
-  A unique identifier for the `Invitation`.
+  The unique identifier for the `Invitation`.
 
   ---
 
@@ -25,21 +25,21 @@ The Backend `Invitation` object represents an invitation to join your applicatio
   - `publicMetadata`
   - [`UserPublicMetadata`](/docs/references/javascript/types/metadata#user-public-metadata)
 
-  Metadata that can be read from the Frontend API and [Backend API](/docs/reference/backend-api){{ target: '_blank' }} and can be set only from the Backend API .
+  Metadata that can be read from the Frontend API and [Backend API](/docs/reference/backend-api){{ target: '_blank' }} and can be set only from the Backend API. Once the user accepts the invitation and signs up, these metadata will end up in the user's public metadata.
 
   ---
 
   - `createdAt`
   - `number`
 
-  Date when the `Invitation` was first created.
+  The date when the `Invitation` was first created.
 
   ---
 
   - `updatedAt`
   - `number`
 
-  Date of the last time the `Invitation` was updated.
+  The date when the `Invitation` was last updated.
 
   ---
 

diff --git a/docs/references/backend/types/backend-organization-invitation.mdx b/docs/references/backend/types/backend-organization-invitation.mdx
@@ -11,7 +11,7 @@ The Backend `OrganizationInvitation` object is similar to the [`OrganizationInvi
   - `id`
   - `string`
 
-  A unique identifier for the invitation.
+  The unique identifier for the `OrganizationInvitation`.
 
   ---
 
@@ -39,14 +39,14 @@ The Backend `OrganizationInvitation` object is similar to the [`OrganizationInvi
   - `createdAt`
   - `number`
 
-  Date when the invitation was first created.
+  The date when the invitation was first created.
 
   ---
 
   - `updatedAt`
   - `number`
 
-  Date of the last time the invitation was updated.
+  The date when the invitation was last updated.
 
   ---
 
@@ -58,14 +58,14 @@ The Backend `OrganizationInvitation` object is similar to the [`OrganizationInvi
   ---
 
   - `publicMetadata`
-  - [`UserPublicMetadata`](/docs/references/javascript/types/metadata#user-public-metadata)
+  - [`OrganizationInvitationPublicMetadata`](/docs/references/javascript/types/metadata#organization-invitation-public-metadata)
 
   Metadata that can be read from the Frontend API and [Backend API](/docs/reference/backend-api){{ target: '_blank' }} and can be set only from the Backend API.
 
   ---
 
   - `privateMetadata`
-  - [`UserPrivateMetadata`](/docs/references/javascript/types/metadata#user-private-metadata)
+  - [`OrganizationInvitationPrivateMetadata`](/docs/references/javascript/types/metadata#organization-invitation-private-metadata)
 
   Metadata that can be read and set only from the [Backend API](/docs/reference/backend-api){{ target: '_blank' }}.
 </Properties>