From ca5914dbfbb5f0b7f938493042040010aaba45d2 Mon Sep 17 00:00:00 2001
From: Julien Fontanet <julien.fontanet@isonoe.net>
Date: Tue, 17 May 2022 14:06:56 +0200
Subject: [PATCH] docs(backups): outline writer API

---
 @xen-orchestra/backups/docs/VM backups/README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/@xen-orchestra/backups/docs/VM backups/README.md b/@xen-orchestra/backups/docs/VM backups/README.md
index e4be9c325..7e68fee31 100644
--- a/@xen-orchestra/backups/docs/VM backups/README.md	
+++ b/@xen-orchestra/backups/docs/VM backups/README.md	
@@ -6,6 +6,7 @@
 - [Task logs](#task-logs)
   - [During backup](#during-backup)
   - [During restoration](#during-restoration)
+- [Writer API](#writer-api)
 
 ## File structure on remote
 
@@ -95,3 +96,15 @@ task.start(message: 'restore', data: { jobId: string, srId: string, time: number
 │  └─ task.end(result: { id: string, size: number })
 └─ task.end
 ```
+
+## Writer API
+
+- `beforeBackup()`
+  - **Delta**
+    - `checkBaseVdis(baseUuidToSrcVdi, baseVm)`
+    - `prepare({ isFull })`
+    - `transfer({ timestamp, deltaExport, sizeContainers })`
+    - `cleanup()`
+  - **Full**
+    - `run({ timestamp, sizeContainer, stream })`
+- `afterBackup()`