diff --git a/.changeset/honest-plants-kneel.md b/.changeset/honest-plants-kneel.md new file mode 100644 index 00000000000..4f2426b90ba --- /dev/null +++ b/.changeset/honest-plants-kneel.md @@ -0,0 +1,5 @@ +--- +"@clerk/backend": patch +--- + +Add JSDoc around Machine and M2M resource types diff --git a/.typedoc/__tests__/__snapshots__/file-structure.test.ts.snap b/.typedoc/__tests__/__snapshots__/file-structure.test.ts.snap index d1e136ab8bf..84f3fb5e041 100644 --- a/.typedoc/__tests__/__snapshots__/file-structure.test.ts.snap +++ b/.typedoc/__tests__/__snapshots__/file-structure.test.ts.snap @@ -252,6 +252,10 @@ exports[`Typedoc output > should have a deliberate file structure 1`] = ` "backend/infer-auth-object-from-token.mdx", "backend/invitation-status.mdx", "backend/invitation.mdx", + "backend/m2-m-token.mdx", + "backend/machine-scope.mdx", + "backend/machine-secret-key.mdx", + "backend/machine.mdx", "backend/o-auth-application.mdx", "backend/organization-invitation-status.mdx", "backend/organization-invitation.mdx", diff --git a/packages/backend/src/api/resources/M2MToken.ts b/packages/backend/src/api/resources/M2MToken.ts index db8437ff0a7..48ccf78bf1d 100644 --- a/packages/backend/src/api/resources/M2MToken.ts +++ b/packages/backend/src/api/resources/M2MToken.ts @@ -1,5 +1,8 @@ import type { M2MTokenJSON } from './JSON'; +/** + * The Backend `M2MToken` object holds information about a machine-to-machine token. + */ export class M2MToken { constructor( readonly id: string, diff --git a/packages/backend/src/api/resources/Machine.ts b/packages/backend/src/api/resources/Machine.ts index 079ca8a2e7f..8f01f96570b 100644 --- a/packages/backend/src/api/resources/Machine.ts +++ b/packages/backend/src/api/resources/Machine.ts @@ -1,5 +1,8 @@ import type { MachineJSON } from './JSON'; +/** + * The Backend `Machine` object holds information about a machine. + */ export class Machine { constructor( readonly id: string, diff --git a/packages/backend/src/api/resources/MachineScope.ts b/packages/backend/src/api/resources/MachineScope.ts index 9a7440b1109..1cfc1392435 100644 --- a/packages/backend/src/api/resources/MachineScope.ts +++ b/packages/backend/src/api/resources/MachineScope.ts @@ -1,5 +1,8 @@ import type { MachineScopeJSON } from './JSON'; +/** + * The Backend `MachineScope` object holds information about a machine scope. + */ export class MachineScope { constructor( readonly fromMachineId: string, diff --git a/packages/backend/src/api/resources/MachineSecretKey.ts b/packages/backend/src/api/resources/MachineSecretKey.ts index ba6245efe55..b2afe99d1d7 100644 --- a/packages/backend/src/api/resources/MachineSecretKey.ts +++ b/packages/backend/src/api/resources/MachineSecretKey.ts @@ -1,5 +1,8 @@ import type { MachineSecretKeyJSON } from './JSON'; +/** + * The Backend `MachineSecretKey` object holds information about a machine secret key. + */ export class MachineSecretKey { constructor(readonly secret: string) {}