commit 161d9bcc0a9c039614d79e6059c2f727769d292b parent 5e64178ee5577fa490350d0c9e5d903587ac4ac4 Author: Florian Dold <florian@dold.me> Date: Wed, 6 Nov 2024 14:35:44 +0100 update wallet-core API docs Diffstat:
| M | wallet/wallet-core.md | | | 42 | ++++++++++++++++++++++++++++++++++++++++++ |
1 file changed, 42 insertions(+), 0 deletions(-)
diff --git a/wallet/wallet-core.md b/wallet/wallet-core.md @@ -79,6 +79,7 @@ This file is auto-generated from [wallet-core](https://git.taler.net/wallet-core * [ImportBackupRecoveryOp](#importbackuprecoveryop) * [RunBackupCycleOp](#runbackupcycleop) * [ExportBackupOp](#exportbackupop) +* [ExportDbToFileOp](#exportdbtofileop) * [AddBackupProviderOp](#addbackupproviderop) * [RemoveBackupProviderOp](#removebackupproviderop) * [GetBackupInfoOp](#getbackupinfoop) @@ -2188,6 +2189,47 @@ export type ExportBackupOp = { ``` +### ExportDbToFileOp +```typescript +/** + * Export the database to a file. + * + * The target directory must already exist. + */ +export type ExportDbToFileOp = { + op: WalletApiOperation.ExportDbToFile; + request: ExportDbToFileRequest; + response: ExportDbToFileResponse; +}; +// ExportDbToFile = "exportDbToFile" + +``` +```typescript +export interface ExportDbToFileRequest { + /** + * Directory that the DB should be exported into. + */ + directory: string; + /** + * Stem of the exported DB filename. + * + * The final name will be ${directory}/${stem}.${extension}, + * where the extension depends on the used DB backend. + */ + stem: string; +} + +``` +```typescript +export interface ExportDbToFileResponse { + /** + * Full path to the backup. + */ + path: string; +} + +``` + ### AddBackupProviderOp ```typescript /**