Skip to content

Commit 7c976b4

Browse files
authored
chore(backend): Add JSDoc around machines and m2m resource types (#6774)
1 parent 719856f commit 7c976b4

File tree

6 files changed

+21
-0
lines changed

6 files changed

+21
-0
lines changed

.changeset/honest-plants-kneel.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@clerk/backend": patch
3+
---
4+
5+
Add JSDoc around Machine and M2M resource types

.typedoc/__tests__/__snapshots__/file-structure.test.ts.snap

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -252,6 +252,10 @@ exports[`Typedoc output > should have a deliberate file structure 1`] = `
252252
"backend/infer-auth-object-from-token.mdx",
253253
"backend/invitation-status.mdx",
254254
"backend/invitation.mdx",
255+
"backend/m2-m-token.mdx",
256+
"backend/machine-scope.mdx",
257+
"backend/machine-secret-key.mdx",
258+
"backend/machine.mdx",
255259
"backend/o-auth-application.mdx",
256260
"backend/organization-invitation-status.mdx",
257261
"backend/organization-invitation.mdx",

packages/backend/src/api/resources/M2MToken.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
import type { M2MTokenJSON } from './JSON';
22

3+
/**
4+
* The Backend `M2MToken` object holds information about a machine-to-machine token.
5+
*/
36
export class M2MToken {
47
constructor(
58
readonly id: string,

packages/backend/src/api/resources/Machine.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
import type { MachineJSON } from './JSON';
22

3+
/**
4+
* The Backend `Machine` object holds information about a machine.
5+
*/
36
export class Machine {
47
constructor(
58
readonly id: string,

packages/backend/src/api/resources/MachineScope.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
import type { MachineScopeJSON } from './JSON';
22

3+
/**
4+
* The Backend `MachineScope` object holds information about a machine scope.
5+
*/
36
export class MachineScope {
47
constructor(
58
readonly fromMachineId: string,

packages/backend/src/api/resources/MachineSecretKey.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
import type { MachineSecretKeyJSON } from './JSON';
22

3+
/**
4+
* The Backend `MachineSecretKey` object holds information about a machine secret key.
5+
*/
36
export class MachineSecretKey {
47
constructor(readonly secret: string) {}
58

0 commit comments

Comments
 (0)