Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/honest-plants-kneel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@clerk/backend": patch
---

Add JSDoc around Machine and M2M resource types
4 changes: 4 additions & 0 deletions .typedoc/__tests__/__snapshots__/file-structure.test.ts.snap
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
3 changes: 3 additions & 0 deletions packages/backend/src/api/resources/M2MToken.ts
Original file line number Diff line number Diff line change
@@ -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,
Expand Down
3 changes: 3 additions & 0 deletions packages/backend/src/api/resources/Machine.ts
Original file line number Diff line number Diff line change
@@ -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,
Expand Down
3 changes: 3 additions & 0 deletions packages/backend/src/api/resources/MachineScope.ts
Original file line number Diff line number Diff line change
@@ -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,
Expand Down
3 changes: 3 additions & 0 deletions packages/backend/src/api/resources/MachineSecretKey.ts
Original file line number Diff line number Diff line change
@@ -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) {}

Expand Down