diff --git a/app/controllers/api/migrations.php b/app/controllers/api/migrations.php index 8d9bd2ee52..932fc3ec2f 100644 --- a/app/controllers/api/migrations.php +++ b/app/controllers/api/migrations.php @@ -276,7 +276,7 @@ App::post('/v1/migrations/firebase') ->label('sdk.response.type', Response::CONTENT_TYPE_JSON) ->label('sdk.response.model', Response::MODEL_MIGRATION) ->param('resources', [], new ArrayList(new WhiteList(Firebase::getSupportedResources())), 'List of resources to migrate') - ->param('serviceAccount', '', new Text(512), "Source's Service Account") + ->param('serviceAccount', '', new Text(1024), "JSON of the Firebase service account credentials") ->inject('response') ->inject('dbForProject') ->inject('project') @@ -326,7 +326,7 @@ App::get('/v1/migrations/firebase/report') ->label('sdk.response.type', Response::CONTENT_TYPE_JSON) ->label('sdk.response.model', Response::MODEL_MIGRATION_REPORT) ->param('resources', [], new ArrayList(new WhiteList(Firebase::getSupportedResources())), 'List of resources to migrate') - ->param('serviceAccount', '', new Text(512), "Source's Service Account") + ->param('serviceAccount', '', new Text(1024), "JSON of the Firebase service account credentials") ->param('databaseURL', '', new URL(), "Source's Database URL") ->inject('response') ->inject('dbForProject') diff --git a/docs/references/migrations/delete-migration.md b/docs/references/migrations/delete-migration.md new file mode 100644 index 0000000000..285081db51 --- /dev/null +++ b/docs/references/migrations/delete-migration.md @@ -0,0 +1 @@ +Delete a migration by its unique ID. \ No newline at end of file diff --git a/docs/references/migrations/get-migration.md b/docs/references/migrations/get-migration.md new file mode 100644 index 0000000000..e56e31f204 --- /dev/null +++ b/docs/references/migrations/get-migration.md @@ -0,0 +1 @@ +Get a migration by its unique ID. \ No newline at end of file diff --git a/docs/references/migrations/list-migrations.md b/docs/references/migrations/list-migrations.md new file mode 100644 index 0000000000..1650f37c51 --- /dev/null +++ b/docs/references/migrations/list-migrations.md @@ -0,0 +1 @@ +Get a list of all the project's migrations. You can use the query params to filter your results. \ No newline at end of file diff --git a/docs/references/migrations/migration-appwrite-report.md b/docs/references/migrations/migration-appwrite-report.md new file mode 100644 index 0000000000..f83c80cf1e --- /dev/null +++ b/docs/references/migrations/migration-appwrite-report.md @@ -0,0 +1 @@ +Perform permission checks and generate a report total data contained within a Appwrite instance including it's version number \ No newline at end of file diff --git a/docs/references/migrations/migration-appwrite.md b/docs/references/migrations/migration-appwrite.md new file mode 100644 index 0000000000..d00f7b7f51 --- /dev/null +++ b/docs/references/migrations/migration-appwrite.md @@ -0,0 +1 @@ +Initialize a migration to transfer data from an Appwrite instance over to your current Appwrite instance. The migration will be queued and processed by the Appwrite server. To learn more about the migration process, please check out our [migration guide](/docs/migrations). \ No newline at end of file diff --git a/docs/references/migrations/migration-firebase-report.md b/docs/references/migrations/migration-firebase-report.md new file mode 100644 index 0000000000..86771b9deb --- /dev/null +++ b/docs/references/migrations/migration-firebase-report.md @@ -0,0 +1 @@ +Perform permission checks against a Firebase project to make sure migration is possible with the supplied credentials. This API does not return any data. It only checks the permissions. \ No newline at end of file diff --git a/docs/references/migrations/migration-firebase.md b/docs/references/migrations/migration-firebase.md new file mode 100644 index 0000000000..cce2dcd4d8 --- /dev/null +++ b/docs/references/migrations/migration-firebase.md @@ -0,0 +1 @@ +Initialize a migration to transfer data from an Firebase project over to your current Appwrite instance. The migration will be queued and processed by the Appwrite server. To learn more about the migration process, please check out our [migration guide](/docs/migrations). \ No newline at end of file diff --git a/docs/references/migrations/migration-nhost-report.md b/docs/references/migrations/migration-nhost-report.md new file mode 100644 index 0000000000..3734714ae1 --- /dev/null +++ b/docs/references/migrations/migration-nhost-report.md @@ -0,0 +1 @@ +Perform permission checks and generate a report total data contained within a NHost instance \ No newline at end of file diff --git a/docs/references/migrations/migration-nhost.md b/docs/references/migrations/migration-nhost.md new file mode 100644 index 0000000000..1914f997a0 --- /dev/null +++ b/docs/references/migrations/migration-nhost.md @@ -0,0 +1 @@ +Initialize a migration to transfer data from an NHost instance over to your current Appwrite instance. The migration will be queued and processed by the Appwrite server. To learn more about the migration process, please check out our [migration guide](/docs/migrations). \ No newline at end of file diff --git a/docs/references/migrations/migration-supabase-report.md b/docs/references/migrations/migration-supabase-report.md new file mode 100644 index 0000000000..8ac10004f2 --- /dev/null +++ b/docs/references/migrations/migration-supabase-report.md @@ -0,0 +1 @@ +Perform permission checks and generate a report total data contained within a Supabase instance \ No newline at end of file diff --git a/docs/references/migrations/migration-supabase.md b/docs/references/migrations/migration-supabase.md new file mode 100644 index 0000000000..933f10fe46 --- /dev/null +++ b/docs/references/migrations/migration-supabase.md @@ -0,0 +1 @@ +Initialize a migration to transfer data from an Supabase instance over to your current Appwrite instance. The migration will be queued and processed by the Appwrite server. To learn more about the migration process, please check out our [migration guide](/docs/migrations). \ No newline at end of file diff --git a/docs/references/migrations/retry-migration.md b/docs/references/migrations/retry-migration.md new file mode 100644 index 0000000000..edfbd421eb --- /dev/null +++ b/docs/references/migrations/retry-migration.md @@ -0,0 +1 @@ +Retry a migration by its unique ID. The migration status must be failed or aborted for the request to succeed. \ No newline at end of file