From 45872260ed05c3d848f8c38e1582b09237c0d181 Mon Sep 17 00:00:00 2001
From: Richard Fontein <32132657+rifont@users.noreply.github.com>
Date: Thu, 14 Nov 2024 23:57:47 +0100
Subject: [PATCH] docs(migration): update preference centralization comments

---
 .../preference-centralization.migration.ts               | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/apps/api/migrations/preference-centralization/preference-centralization.migration.ts b/apps/api/migrations/preference-centralization/preference-centralization.migration.ts
index b2486d06994..a880553def2 100644
--- a/apps/api/migrations/preference-centralization/preference-centralization.migration.ts
+++ b/apps/api/migrations/preference-centralization/preference-centralization.migration.ts
@@ -22,7 +22,14 @@ const sleep = (ms: number) => {
 };
 
 /**
- * Migration to centralize workflow and subscriber preferences
+ * Migration to centralize workflow and subscriber preferences.
+ * - subscriber global preference
+ *    -> preferences with subscriber global type
+ * - subscriber workflow preferences
+ *    -> preferences with subscriber worklow type
+ * - workflow preferences
+ *   -> preferences with workflow-resource type
+ *   -> preferences with user-workflow type
  */
 export async function preferenceCentralization() {
   const app = await NestFactory.create(AppModule, {