From 91fed7a255d1b04f904fd4e5b013812c95d54082 Mon Sep 17 00:00:00 2001 From: shimon Date: Thu, 9 Nov 2023 12:54:33 +0200 Subject: [PATCH] editing the response models --- .../Utopia/Response/Model/UsageBuckets.php | 10 +++--- .../Utopia/Response/Model/UsageCollection.php | 6 ++-- .../Utopia/Response/Model/UsageDatabase.php | 10 +++--- .../Utopia/Response/Model/UsageDatabases.php | 14 ++++---- .../Utopia/Response/Model/UsageFunction.php | 28 +++++++-------- .../Utopia/Response/Model/UsageFunctions.php | 34 +++++++++---------- .../Utopia/Response/Model/UsageProject.php | 16 ++++----- .../Utopia/Response/Model/UsageStorage.php | 14 ++++---- .../Utopia/Response/Model/UsageUsers.php | 10 +++--- 9 files changed, 71 insertions(+), 71 deletions(-) diff --git a/src/Appwrite/Utopia/Response/Model/UsageBuckets.php b/src/Appwrite/Utopia/Response/Model/UsageBuckets.php index 0eec40148e..2f528ac9d1 100644 --- a/src/Appwrite/Utopia/Response/Model/UsageBuckets.php +++ b/src/Appwrite/Utopia/Response/Model/UsageBuckets.php @@ -12,32 +12,32 @@ class UsageBuckets extends Model $this ->addRule('range', [ 'type' => self::TYPE_STRING, - 'description' => 'The time range of the usage stats.', + 'description' => 'Time range of the usage stats.', 'default' => '', 'example' => '30d', ]) ->addRule('filesTotal', [ 'type' => self::TYPE_INTEGER, - 'description' => 'Aggregated total statistics of bucket files.', + 'description' => 'Total aggregated number of bucket files.', 'default' => 0, 'example' => 0, ]) ->addRule('filesStorageTotal', [ 'type' => self::TYPE_INTEGER, - 'description' => 'Aggregated total statistics of bucket files storage.', + 'description' => 'Total aggregated number of bucket files storage (in bytes).', 'default' => 0, 'example' => 0, ]) ->addRule('files', [ 'type' => Response::MODEL_METRIC, - 'description' => 'Aggregated statistics of bucket files per period.', + 'description' => 'Aggregated number of bucket files per period.', 'default' => [], 'example' => [], 'array' => true ]) ->addRule('storage', [ 'type' => Response::MODEL_METRIC, - 'description' => 'Aggregated statistics of bucket storage files per period.', + 'description' => 'Aggregated number of bucket storage files (in bytes) per period.', 'default' => [], 'example' => [], 'array' => true diff --git a/src/Appwrite/Utopia/Response/Model/UsageCollection.php b/src/Appwrite/Utopia/Response/Model/UsageCollection.php index f4874a7e01..b2336d65ba 100644 --- a/src/Appwrite/Utopia/Response/Model/UsageCollection.php +++ b/src/Appwrite/Utopia/Response/Model/UsageCollection.php @@ -12,19 +12,19 @@ class UsageCollection extends Model $this ->addRule('range', [ 'type' => self::TYPE_STRING, - 'description' => 'The time range of the usage stats.', + 'description' => 'Time range of the usage stats.', 'default' => '', 'example' => '30d', ]) ->addRule('documentsTotal', [ 'type' => self::TYPE_INTEGER, - 'description' => 'Aggregated total statistics of documents.', + 'description' => 'Total aggregated number of of documents.', 'default' => 0, 'example' => 0, ]) ->addRule('documents', [ 'type' => Response::MODEL_METRIC, - 'description' => 'Aggregated statistics of documents per period.', + 'description' => 'Aggregated number of documents per period.', 'default' => [], 'example' => [], 'array' => true diff --git a/src/Appwrite/Utopia/Response/Model/UsageDatabase.php b/src/Appwrite/Utopia/Response/Model/UsageDatabase.php index 7a880e7289..d4733f2568 100644 --- a/src/Appwrite/Utopia/Response/Model/UsageDatabase.php +++ b/src/Appwrite/Utopia/Response/Model/UsageDatabase.php @@ -12,32 +12,32 @@ class UsageDatabase extends Model $this ->addRule('range', [ 'type' => self::TYPE_STRING, - 'description' => 'The time range of the usage stats.', + 'description' => 'Time range of the usage stats.', 'default' => '', 'example' => '30d', ]) ->addRule('collectionsTotal', [ 'type' => self::TYPE_INTEGER, - 'description' => 'Aggregated total statistics of collections.', + 'description' => 'Total aggregated number of collections.', 'default' => 0, 'example' => 0, ]) ->addRule('documentsTotal', [ 'type' => self::TYPE_INTEGER, - 'description' => 'Aggregated total statistics of documents.', + 'description' => 'Total aggregated number of documents.', 'default' => 0, 'example' => 0, ]) ->addRule('collections', [ 'type' => Response::MODEL_METRIC, - 'description' => 'Aggregated statistics collections per period.', + 'description' => 'Aggregated number of collections per period.', 'default' => [], 'example' => [], 'array' => true ]) ->addRule('documents', [ 'type' => Response::MODEL_METRIC, - 'description' => 'Aggregated statistics of documents per period.', + 'description' => 'Aggregated number of documents per period.', 'default' => [], 'example' => [], 'array' => true diff --git a/src/Appwrite/Utopia/Response/Model/UsageDatabases.php b/src/Appwrite/Utopia/Response/Model/UsageDatabases.php index 0844fc20fc..f775f9489d 100644 --- a/src/Appwrite/Utopia/Response/Model/UsageDatabases.php +++ b/src/Appwrite/Utopia/Response/Model/UsageDatabases.php @@ -12,45 +12,45 @@ class UsageDatabases extends Model $this ->addRule('range', [ 'type' => self::TYPE_STRING, - 'description' => 'The time range of the usage stats.', + 'description' => 'Time range of the usage stats.', 'default' => '', 'example' => '30d', ]) ->addRule('databasesTotal', [ 'type' => self::TYPE_INTEGER, - 'description' => 'Aggregated total statistics of documents.', + 'description' => 'Total aggregated number of databases.', 'default' => 0, 'example' => 0, ]) ->addRule('collectionsTotal', [ 'type' => self::TYPE_INTEGER, - 'description' => 'Aggregated total statistics of collections.', + 'description' => 'Total aggregated number of collections.', 'default' => 0, 'example' => 0, ]) ->addRule('documentsTotal', [ 'type' => self::TYPE_INTEGER, - 'description' => 'Aggregated total statistics of documents.', + 'description' => 'Total aggregated number of documents.', 'default' => 0, 'example' => 0, ]) ->addRule('databases', [ 'type' => Response::MODEL_METRIC, - 'description' => 'Aggregated total statistics of documents per period.', + 'description' => 'Aggregated number of databases per period.', 'default' => [], 'example' => [], 'array' => true ]) ->addRule('collections', [ 'type' => Response::MODEL_METRIC, - 'description' => 'Aggregated total statistics of collections per period.', + 'description' => 'Aggregated number of collections per period.', 'default' => [], 'example' => [], 'array' => true ]) ->addRule('documents', [ 'type' => Response::MODEL_METRIC, - 'description' => 'Aggregated total statistics of documents per period.', + 'description' => 'Aggregated number of documents per period.', 'default' => [], 'example' => [], 'array' => true diff --git a/src/Appwrite/Utopia/Response/Model/UsageFunction.php b/src/Appwrite/Utopia/Response/Model/UsageFunction.php index f6a8b32dab..5a17fd154c 100644 --- a/src/Appwrite/Utopia/Response/Model/UsageFunction.php +++ b/src/Appwrite/Utopia/Response/Model/UsageFunction.php @@ -18,84 +18,84 @@ class UsageFunction extends Model ]) ->addRule('deploymentsTotal', [ 'type' => self::TYPE_INTEGER, - 'description' => 'Aggregated total statistics of function deployments.', + 'description' => 'Total aggregated number of function deployments.', 'default' => 0, 'example' => 0, ]) ->addRule('deploymentsStorageTotal', [ 'type' => self::TYPE_INTEGER, - 'description' => 'Aggregated total statistics of function deployments storage.', + 'description' => 'Total aggregated sum of function deployments storage.', 'default' => 0, 'example' => 0, ]) ->addRule('buildsTotal', [ 'type' => self::TYPE_INTEGER, - 'description' => 'Aggregated total statistics of function builds.', + 'description' => 'Total aggregated number of function builds.', 'default' => 0, 'example' => 0, ]) ->addRule('buildsStorageTotal', [ 'type' => self::TYPE_INTEGER, - 'description' => 'Aggregate total statistics of builds storage.', + 'description' => 'total aggregated sum of function builds storage.', 'default' => 0, 'example' => 0, ]) ->addRule('buildsTimeTotal', [ 'type' => self::TYPE_INTEGER, - 'description' => 'Aggregate total statistics of build compute time.', + 'description' => 'Total aggregated sum of function builds compute time.', 'default' => 0, 'example' => 0, ]) ->addRule('executionsTotal', [ 'type' => self::TYPE_INTEGER, - 'description' => 'Aggregated total statistics of executions.', + 'description' => 'Total aggregated number of function executions.', 'default' => 0, 'example' => 0, ]) ->addRule('executionsTimeTotal', [ 'type' => self::TYPE_INTEGER, - 'description' => 'Aggregated total statistics if execution compute time.', + 'description' => 'Total aggregated sum of function executions compute time.', 'default' => 0, 'example' => 0, ]) ->addRule('deployments', [ 'type' => Response::MODEL_METRIC, - 'description' => 'Aggregated statistics of deployments per time period.', + 'description' => 'Aggregated number of function deployments per period.', 'default' => [], 'example' => [], 'array' => true ]) ->addRule('deploymentsStorage', [ 'type' => Response::MODEL_METRIC, - 'description' => 'Aggregated statistics of deployment storage per time period.', + 'description' => 'Aggregated number of function deployments storage per period.', 'default' => [], 'example' => [], 'array' => true ]) ->addRule('builds', [ 'type' => Response::MODEL_METRIC, - 'description' => 'Aggregated statistics of builds per time period.', + 'description' => 'Aggregated number of function builds per period.', 'default' => [], 'example' => [], 'array' => true ]) ->addRule('buildsStorage', [ 'type' => Response::MODEL_METRIC, - 'description' => 'Aggregated statistics of build storage per time period.', + 'description' => 'Aggregated sum of function builds storage per period.', 'default' => [], 'example' => [], 'array' => true ]) ->addRule('buildsTime', [ 'type' => Response::MODEL_METRIC, - 'description' => 'Aggregated statistics of build compute per time period.', + 'description' => 'Aggregated sum of function builds compute time per period.', 'default' => [], 'example' => [], 'array' => true ]) ->addRule('executions', [ 'type' => Response::MODEL_METRIC, - 'description' => 'Aggregated statistics of executions per time period.', + 'description' => 'Aggregated number of function executions per period.', 'default' => [], 'example' => [], 'array' => true @@ -103,7 +103,7 @@ class UsageFunction extends Model ->addRule('executionsTime', [ 'type' => Response::MODEL_METRIC, - 'description' => 'Aggregated statistics of executions compute per time period.', + 'description' => 'Aggregated number of function executions compute time per period.', 'default' => [], 'example' => [], 'array' => true diff --git a/src/Appwrite/Utopia/Response/Model/UsageFunctions.php b/src/Appwrite/Utopia/Response/Model/UsageFunctions.php index c654d9053d..f5bc251d45 100644 --- a/src/Appwrite/Utopia/Response/Model/UsageFunctions.php +++ b/src/Appwrite/Utopia/Response/Model/UsageFunctions.php @@ -12,103 +12,103 @@ class UsageFunctions extends Model $this ->addRule('range', [ 'type' => self::TYPE_STRING, - 'description' => 'The time range of the usage stats.', + 'description' => 'Time range of the usage stats.', 'default' => '', 'example' => '30d', ]) ->addRule('functionsTotal', [ 'type' => self::TYPE_INTEGER, - 'description' => 'Aggregated total statistics of functions.', + 'description' => 'Total aggregated number of functions.', 'default' => 0, 'example' => 0, ]) ->addRule('deploymentsTotal', [ 'type' => self::TYPE_INTEGER, - 'description' => 'Aggregated total statistics of function deployments.', + 'description' => 'Total aggregated number of functions deployments.', 'default' => 0, 'example' => 0, ]) ->addRule('deploymentsStorageTotal', [ 'type' => self::TYPE_INTEGER, - 'description' => 'Aggregated total statistics of function deployments storage.', + 'description' => 'Total aggregated sum of functions deployment storage.', 'default' => 0, 'example' => 0, ]) ->addRule('buildsTotal', [ 'type' => self::TYPE_INTEGER, - 'description' => 'Aggregated total statistics of function builds.', + 'description' => 'Total aggregated number of functions build.', 'default' => 0, 'example' => 0, ]) ->addRule('buildsStorageTotal', [ 'type' => self::TYPE_INTEGER, - 'description' => 'Aggregated total statistics of builds storage.', + 'description' => 'total aggregated sum of functions build storage.', 'default' => 0, 'example' => 0, ]) ->addRule('buildsTimeTotal', [ 'type' => self::TYPE_INTEGER, - 'description' => 'Aggregated total statistics of build compute time.', + 'description' => 'Total aggregated sum of functions build compute time.', 'default' => 0, 'example' => 0, ]) ->addRule('executionsTotal', [ 'type' => self::TYPE_INTEGER, - 'description' => 'Aggregated total statistics of functions executions.', + 'description' => 'Total aggregated number of functions execution.', 'default' => 0, 'example' => 0, ]) ->addRule('executionsTimeTotal', [ 'type' => self::TYPE_INTEGER, - 'description' => 'Aggregated total statistics of functions execution compute time.', + 'description' => 'Total aggregated sum of functions execution compute time.', 'default' => 0, 'example' => 0, ]) ->addRule('functions', [ 'type' => Response::MODEL_METRIC, - 'description' => 'Aggregated statistics of functions per period.', + 'description' => 'Aggregated number of functions per period.', 'default' => 0, 'example' => 0, 'array' => true ]) ->addRule('deployments', [ 'type' => Response::MODEL_METRIC, - 'description' => 'Aggregated statistics of deployments per period.', + 'description' => 'Aggregated number of functions deployment per period.', 'default' => [], 'example' => [], 'array' => true ]) ->addRule('deploymentsStorage', [ 'type' => Response::MODEL_METRIC, - 'description' => 'Aggregated statistics of deployments storage per period.', + 'description' => 'Aggregated number of functions deployment storage per period.', 'default' => [], 'example' => [], 'array' => true ]) ->addRule('builds', [ 'type' => Response::MODEL_METRIC, - 'description' => 'Aggregated statistics of builds per period.', + 'description' => 'Aggregated number of functions build per period.', 'default' => [], 'example' => [], 'array' => true ]) ->addRule('buildsStorage', [ 'type' => Response::MODEL_METRIC, - 'description' => 'Aggregated statistics of storage per period.', + 'description' => 'Aggregated sum of functions build storage per period.', 'default' => [], 'example' => [], 'array' => true ]) ->addRule('buildsTime', [ 'type' => Response::MODEL_METRIC, - 'description' => 'Aggregated statistics of builds compute time per period.', + 'description' => 'Aggregated sum of functions build compute time per period.', 'default' => [], 'example' => [], 'array' => true ]) ->addRule('executions', [ 'type' => Response::MODEL_METRIC, - 'description' => 'Aggregated statistics of executions per period.', + 'description' => 'Aggregated number of functions execution per period.', 'default' => [], 'example' => [], 'array' => true @@ -116,7 +116,7 @@ class UsageFunctions extends Model ->addRule('executionsTime', [ 'type' => Response::MODEL_METRIC, - 'description' => 'Aggregated statistics of execution compute time per period.', + 'description' => 'Aggregated number of functions execution compute time per period.', 'default' => [], 'example' => [], 'array' => true diff --git a/src/Appwrite/Utopia/Response/Model/UsageProject.php b/src/Appwrite/Utopia/Response/Model/UsageProject.php index 5e2c261717..de16dcc114 100644 --- a/src/Appwrite/Utopia/Response/Model/UsageProject.php +++ b/src/Appwrite/Utopia/Response/Model/UsageProject.php @@ -18,50 +18,50 @@ class UsageProject extends Model ]) ->addRule('executionsTotal', [ 'type' => self::TYPE_INTEGER, - 'description' => 'Aggregated statistics of total function executions.', + 'description' => 'Total aggregated number of function executions.', 'default' => 0, 'example' => 0, ]) ->addRule('documentsTotal', [ 'type' => self::TYPE_INTEGER, - 'description' => 'Aggregated statistics of total number of documents.', + 'description' => 'Total aggregated number of documents.', 'default' => 0, 'example' => 0, ]) ->addRule('databasesTotal', [ 'type' => self::TYPE_INTEGER, - 'description' => 'Aggregated statistics of total number of databases.', + 'description' => 'Total aggregated number of databases.', 'default' => 0, 'example' => 0, ]) ->addRule('usersTotal', [ 'type' => self::TYPE_INTEGER, - 'description' => 'Aggregated statistics of total number of users.', + 'description' => 'Total aggregated number of users.', 'default' => 0, 'example' => 0, ]) ->addRule('filesStorageTotal', [ 'type' => self::TYPE_INTEGER, - 'description' => 'Aggregated statistics of total occupied storage size (in bytes).', + 'description' => 'Total aggregated sum of files storage size (in bytes).', 'default' => 0, 'example' => 0, ]) ->addRule('bucketsTotal', [ 'type' => self::TYPE_INTEGER, - 'description' => 'Aggregated statistics of total number of buckets.', + 'description' => 'Total aggregated number of buckets.', 'default' => 0, 'example' => 0, ]) ->addRule('requests', [ 'type' => self::TYPE_INTEGER, - 'description' => 'Aggregated statistics of number of requests per period.', + 'description' => 'Aggregated number of requests per period.', 'default' => [], 'example' => [], 'array' => true ]) ->addRule('network', [ 'type' => self::TYPE_INTEGER, - 'description' => 'Aggregated statistics of consumed bandwidth per period.', + 'description' => 'Aggregated number of consumed bandwidth per period.', 'default' => [], 'example' => [], 'array' => true diff --git a/src/Appwrite/Utopia/Response/Model/UsageStorage.php b/src/Appwrite/Utopia/Response/Model/UsageStorage.php index 2fc30fbfa0..89b771ccd7 100644 --- a/src/Appwrite/Utopia/Response/Model/UsageStorage.php +++ b/src/Appwrite/Utopia/Response/Model/UsageStorage.php @@ -12,45 +12,45 @@ class UsageStorage extends Model $this ->addRule('range', [ 'type' => self::TYPE_STRING, - 'description' => 'The time range of the usage stats.', + 'description' => 'Time range of the usage stats.', 'default' => '', 'example' => '30d', ]) ->addRule('bucketsTotal', [ 'type' => self::TYPE_INTEGER, - 'description' => 'Aggregated total statistics of buckets', + 'description' => 'Total aggregated number of buckets', 'default' => 0, 'example' => 0, ]) ->addRule('filesTotal', [ 'type' => self::TYPE_INTEGER, - 'description' => 'Aggregated total statistics of files.', + 'description' => 'Total aggregated number of files.', 'default' => 0, 'example' => 0, ]) ->addRule('filesStorageTotal', [ 'type' => self::TYPE_INTEGER, - 'description' => 'Aggregated total statistics of files storage (in bytes).', + 'description' => 'Total aggregated number of files storage (in bytes).', 'default' => 0, 'example' => 0, ]) ->addRule('buckets', [ 'type' => Response::MODEL_METRIC, - 'description' => 'Aggregated statistics of buckets per period.', + 'description' => 'Aggregated number of buckets per period.', 'default' => [], 'example' => [], 'array' => true ]) ->addRule('files', [ 'type' => Response::MODEL_METRIC, - 'description' => 'Aggregated statistics of files per period.', + 'description' => 'Aggregated number of files per period.', 'default' => [], 'example' => [], 'array' => true ]) ->addRule('storage', [ 'type' => Response::MODEL_METRIC, - 'description' => 'Aggregated statistics of storage (in bytes) per period .', + 'description' => 'Aggregated number of files storage (in bytes) per period .', 'default' => [], 'example' => [], 'array' => true diff --git a/src/Appwrite/Utopia/Response/Model/UsageUsers.php b/src/Appwrite/Utopia/Response/Model/UsageUsers.php index 0dab9b2628..e2ccbd9afb 100644 --- a/src/Appwrite/Utopia/Response/Model/UsageUsers.php +++ b/src/Appwrite/Utopia/Response/Model/UsageUsers.php @@ -12,26 +12,26 @@ class UsageUsers extends Model $this ->addRule('range', [ 'type' => self::TYPE_STRING, - 'description' => 'The time range of the usage stats.', + 'description' => 'Time range of the usage stats.', 'default' => '', 'example' => '30d', ]) ->addRule('usersTotal', [ 'type' => self::TYPE_INTEGER, - 'description' => 'Aggregated total statistics of users.', + 'description' => 'Total aggregated number of statistics of users.', 'default' => 0, 'example' => 0, ]) ->addRule('sessionsTotal', [ 'type' => self::TYPE_INTEGER, - 'description' => 'Aggregated total statistics sessions created.', + 'description' => 'Total aggregated number of active sessions.', 'default' => 0, 'example' => 0, ]) ->addRule('users', [ 'type' => Response::MODEL_METRIC, - 'description' => 'Aggregated statistics of users per period.', + 'description' => 'Aggregated number of users per period.', 'default' => [], 'example' => [], 'array' => true @@ -39,7 +39,7 @@ class UsageUsers extends Model ->addRule('sessions', [ 'type' => Response::MODEL_METRIC, - 'description' => 'Aggregated statistics sessions created per period.', + 'description' => 'Aggregated number of active sessions per period.', 'default' => [], 'example' => [], 'array' => true