From f904698d660fc1ad6db3e7cdc559ef1d26c27a43 Mon Sep 17 00:00:00 2001 From: Jake Barnby Date: Fri, 26 Aug 2022 16:34:05 +1200 Subject: [PATCH] Add permissions doc links to model rule descriptions --- src/Appwrite/Utopia/Response/Model/Bucket.php | 4 ++-- src/Appwrite/Utopia/Response/Model/Collection.php | 4 ++-- src/Appwrite/Utopia/Response/Model/Document.php | 2 +- src/Appwrite/Utopia/Response/Model/File.php | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/src/Appwrite/Utopia/Response/Model/Bucket.php b/src/Appwrite/Utopia/Response/Model/Bucket.php index 06162d3811..03e08478bc 100644 --- a/src/Appwrite/Utopia/Response/Model/Bucket.php +++ b/src/Appwrite/Utopia/Response/Model/Bucket.php @@ -30,14 +30,14 @@ class Bucket extends Model ]) ->addRule('$permissions', [ 'type' => self::TYPE_STRING, - 'description' => 'File permissions.', + 'description' => 'File permissions. [Learn more about permissions](/docs/permissions) and get a full list of available permissions.', 'default' => [], 'example' => ['read("any")'], 'array' => true, ]) ->addRule('fileSecurity', [ 'type' => self::TYPE_STRING, - 'description' => 'Whether file-level security is enabled.', + 'description' => 'Whether file-level security is enabled. [Learn more about permissions](/docs/permissions).', 'default' => '', 'example' => true, ]) diff --git a/src/Appwrite/Utopia/Response/Model/Collection.php b/src/Appwrite/Utopia/Response/Model/Collection.php index de016593c6..899c93cb90 100644 --- a/src/Appwrite/Utopia/Response/Model/Collection.php +++ b/src/Appwrite/Utopia/Response/Model/Collection.php @@ -30,7 +30,7 @@ class Collection extends Model ]) ->addRule('$permissions', [ 'type' => self::TYPE_STRING, - 'description' => 'Collection permissions.', + 'description' => 'Collection permissions. [Learn more about permissions](/docs/permissions) and get a full list of available permissions.', 'default' => '', 'example' => ['read("any")'], 'array' => true @@ -55,7 +55,7 @@ class Collection extends Model ]) ->addRule('documentSecurity', [ 'type' => self::TYPE_BOOLEAN, - 'description' => 'Whether document-level permissions are enabled.', + 'description' => 'Whether document-level permissions are enabled. [Learn more about permissions](/docs/permissions).', 'default' => '', 'example' => true, ]) diff --git a/src/Appwrite/Utopia/Response/Model/Document.php b/src/Appwrite/Utopia/Response/Model/Document.php index 7ee15f148d..2c2bc02410 100644 --- a/src/Appwrite/Utopia/Response/Model/Document.php +++ b/src/Appwrite/Utopia/Response/Model/Document.php @@ -56,7 +56,7 @@ class Document extends Any ]) ->addRule('$permissions', [ 'type' => self::TYPE_STRING, - 'description' => 'Document permissions.', + 'description' => 'Document permissions. [Learn more about permissions](/docs/permissions) and get a full list of available permissions.', 'default' => '', 'example' => ['read("any")'], 'array' => true, diff --git a/src/Appwrite/Utopia/Response/Model/File.php b/src/Appwrite/Utopia/Response/Model/File.php index 56be419eca..23ef620c75 100644 --- a/src/Appwrite/Utopia/Response/Model/File.php +++ b/src/Appwrite/Utopia/Response/Model/File.php @@ -36,7 +36,7 @@ class File extends Model ]) ->addRule('$permissions', [ 'type' => self::TYPE_STRING, - 'description' => 'File permissions.', + 'description' => 'File permissions. [Learn more about permissions](/docs/permissions) and get a full list of available permissions.', 'default' => [], 'example' => ['read("any")'], 'array' => true,