storage:client
storage:client
Section titled “storage:client”| Field | Value |
|---|---|
| Prefix | storage:client |
| Namespace constant | ClientStorageNamespace |
| Subjects constant | ClientStorageSubjects |
| Kind | storage |
| Schema record | <inline> |
| Tier | framework |
| Package | @makaio/services-core |
| Defined in | packages/services/core/src/settings/storage/clients-namespace.ts |
Subjects
Section titled “Subjects”| Key | Wire | Type | Schema |
|---|---|---|---|
get | storage:client.get | rpc | — |
list | storage:client.list | rpc | — |
listByBinaryName | storage:client.listByBinaryName | rpc | — |
Subject Details
Section titled “Subject Details”storage:client.get (rpc)
Section titled “storage:client.get (rpc)”Subject: storage:client.get
Type: Request (RPC)
Request:
| Field | Type | Required |
|---|---|---|
id | string | yes |
Response:
| Field | Type | Required |
|---|---|---|
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; } | null | yes |
storage:client.list (rpc)
Section titled “storage:client.list (rpc)”Subject: storage:client.list
Type: Request (RPC)
Request:
Empty object.
Response:
| Field | Type | Required |
|---|---|---|
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 |
storage:client.listByBinaryName (rpc)
Section titled “storage:client.listByBinaryName (rpc)”Subject: storage:client.listByBinaryName
Type: Request (RPC)
Request:
| Field | Type | Required |
|---|---|---|
binaryName | string | yes |
Response:
| Field | Type | Required |
|---|---|---|
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.