Skip to content

storage:client

FieldValue
Prefixstorage:client
Namespace constantClientStorageNamespace
Subjects constantClientStorageSubjects
Kindstorage
Schema record<inline>
Tierframework
Package@makaio/services-core
Defined inpackages/services/core/src/settings/storage/clients-namespace.ts
KeyWireTypeSchema
getstorage:client.getrpc
liststorage:client.listrpc
listByBinaryNamestorage:client.listByBinaryNamerpc

Subject: storage:client.get Type: Request (RPC)

Request:

FieldTypeRequired
idstringyes

Response:

FieldTypeRequired
client{ id: string; packageName: string; name: string; nativeTools: { name: string; friendlyName: string; capabilities: { tag: string; description?: string | undefined; }[]; description?: string | undefined; category?: string | undefined; }[]; defaultApprovalPolicy: "reject" | "always-ask" | "full-access"; enabled: boolean; createdAt: number; updatedAt: number; description?: string | undefined; binaryName?: string | undefined; minimumVersion?: string | undefined; logSources?: { id: string; name: string; description?: string | undefined; glob?: string | undefined; }[] | undefined; defaultProviderId?: string | undefined; env?: Record<string, string> | undefined; credentials?: Record<string, string> | undefined; cwd?: string | undefined; } | nullyes

Subject: storage:client.list Type: Request (RPC)

Request:

Empty object.

Response:

FieldTypeRequired
clients{ id: string; packageName: string; name: string; nativeTools: { name: string; friendlyName: string; capabilities: { tag: string; description?: string | undefined; }[]; description?: string | undefined; category?: string | undefined; }[]; defaultApprovalPolicy: "reject" | "always-ask" | "full-access"; enabled: boolean; createdAt: number; updatedAt: number; description?: string | undefined; binaryName?: string | undefined; minimumVersion?: string | undefined; logSources?: { id: string; name: string; description?: string | undefined; glob?: string | undefined; }[] | undefined; defaultProviderId?: string | undefined; env?: Record<string, string> | undefined; credentials?: Record<string, string> | undefined; cwd?: string | undefined; }[]yes

Subject: storage:client.listByBinaryName Type: Request (RPC)

Request:

FieldTypeRequired
binaryNamestringyes

Response:

FieldTypeRequired
clients{ id: string; packageName: string; name: string; nativeTools: { name: string; friendlyName: string; capabilities: { tag: string; description?: string | undefined; }[]; description?: string | undefined; category?: string | undefined; }[]; defaultApprovalPolicy: "reject" | "always-ask" | "full-access"; enabled: boolean; createdAt: number; updatedAt: number; description?: string | undefined; binaryName?: string | undefined; minimumVersion?: string | undefined; logSources?: { id: string; name: string; description?: string | undefined; glob?: string | undefined; }[] | undefined; defaultProviderId?: string | undefined; env?: Record<string, string> | undefined; credentials?: Record<string, string> | undefined; cwd?: string | undefined; }[]yes

Auto-generated by yarn docs:bus. Do not edit manually.