docs(migration): update preference centralization comments

novuhq · Nov 14, 2024 · 4587226 · 4587226
1 parent 80f9860
commit 4587226
Showing 1 changed file with 8 additions and 1 deletion.
diff --git 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, {