V8 Migration doc updated

auth0 · Oct 18, 2024 · 262b582 · 262b582
1 parent 9be1415
commit 262b582
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 27 deletions.
diff --git a/docs/v8_MIGRATION_GUIDE.md b/docs/v8_MIGRATION_GUIDE.md
@@ -3,8 +3,11 @@
 Guide to migrating from `7.x` to `8.x`
 
 - [General](#general)
-  - [Node 18 or newer is required](#node-18-or-newer-is-required)
+    - [Node 18 or newer is required](#node-18-or-newer-is-required)
+    - [Auth0 V4 Migration Guide](https://github.com/auth0/node-auth0/blob/master/v4_MIGRATION_GUIDE.md)
 - [Management Resources](#management-resources)
+    - [EmailProvider](#emailProvider)
+    - [Migrations](#migrations)
 
 ## General
 
@@ -14,28 +17,30 @@ Node 18 LTS and newer LTS releases are supported.
 
 ## Management Resources
 
-| Resource         | Change                        | Description                                   |
-| ---------------- | ----------------------------- | --------------------------------------------- |
-| actions          | No change                     | Same as `7.x`                                 |
-| attackProtection | No change                     | Same as `7.x`                                 |
-| branding         | No change                     | Same as `7.x`                                 |
-| clientGrants     | No change                     | Same as `7.x`                                 |
-| clients          | No change                     | Same as `7.x`                                 |
-| connections      | No change                     | Same as `7.x`                                 |
-| customDomains    | No change                     | Same as `7.x`                                 |
-| emailProvider    | delete operation will disable | delete operation is deprecated on auth0 `4.x` |
-| emailTemplates   | No change                     | Same as `7.x`                                 |
-| guardian         | No change                     | Same as `7.x`                                 |
-| logStreams       | No change                     | Same as `7.x`                                 |
-| organizations    | No change                     | Same as `7.x`                                 |
-| pages            | No change                     | Same as `7.x`                                 |
-| prompts          | No change                     | Same as `7.x`                                 |
-| resourceServers  | No change                     | Same as `7.x`                                 |
-| migrations       | removed support               | Not supported on auth0 `4.x`                  |
-| roles            | No change                     | Same as `7.x`                                 |
-| rules            | No change                     | Will be deprecated soon, migrate to actions   |
-| rulesConfigs     | No change                     | Will be deprecated soon, migrate to actions   |
-| hooks            | No change                     | Will be deprecated soon, migrate to actions   |
-| tenant           | No change                     | Same as `7.x`                                 |
-| themes           | No change                     | Same as `7.x`                                 |
-| triggers         | No change                     | Same as `7.x`                                 |
+| Resource      | Change           | Description                                   |
+|---------------|------------------|-----------------------------------------------|
+| emailProvider | delete operation | Delete operation is deprecated on auth0 `4.x` |
+| migrations    | removed support  | Not supported on auth0 `4.x`                  |
+
+#### Note: Other resources from `7.x` are not affected and no changes are required.
+
+#### emailProvider
+
+The `delete` operation on the `emailProvider` resource will disable the email provider instead of deleting it.
+This is because the email provider deletion operation is deprecated on auth0 `4.x`. User can disable the email provider
+by email provider setting the `enabled` property to `false` from the configuration file.
+
+```yaml
+  emailProvider:
+    # other properties
+    enabled: false
+```
+
+Rest of the operations on emailProvider resource will work the same as `7.x`.
+
+#### migrations
+
+The `migrations` resource is not supported on auth0 `4.x`. It's recommended to remove the `migrations` resource from the
+configuration file. If it's not removed, the deploy CLI will ignore the `migrations` resource for operations.
+
+
diff --git a/src/types.ts b/src/types.ts
@@ -105,7 +105,6 @@ export type Assets = Partial<{
   } | null;
   hooks: Asset[] | null;
   logStreams: LogStream[] | null;
-  migrations: Asset[] | null;
   organizations: Asset[] | null;
   pages: Page[] | null;
   prompts: Prompts | null;