Appwrite/appwrite
1
0
Fork 0
mirror of https://github.com/appwrite/appwrite.git synced 2026-05-26 13:51:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: improve doc examples to use Permission and Roles helper classes

Browse Source
This commit is contained in:
Chirag Aggarwal
2025-10-27 14:13:54 +05:30
parent 15b12551a0
commit 720dfb97e8
203 changed files with 1059 additions and 211 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/examples/1.8.x/server-python/examples/databases/create-collection.md
+3 -1
View File
@@ -1,5 +1,7 @@
from appwrite.client import Client
from appwrite.services.databases import Databases
from appwrite.permission import Permission
from appwrite.role import Role
client = Client()
client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
@@ -12,7 +14,7 @@ result = databases.create_collection(
database_id = '<DATABASE_ID>',
collection_id = '<COLLECTION_ID>',
name = '<NAME>',
permissions = ["read("any")"], # optional
permissions = [Permission.read(Role.any())], # optional
document_security = False, # optional
enabled = False # optional
)
docs/examples/1.8.x/server-python/examples/databases/create-document.md
+3 -1
View File
@@ -1,5 +1,7 @@
from appwrite.client import Client
from appwrite.services.databases import Databases
from appwrite.permission import Permission
from appwrite.role import Role
client = Client()
client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
@@ -19,6 +21,6 @@ result = databases.create_document(
"age": 30,
"isAdmin": False
},
permissions = ["read("any")"], # optional
permissions = [Permission.read(Role.any())], # optional
transaction_id = '<TRANSACTION_ID>' # optional
)
docs/examples/1.8.x/server-python/examples/databases/update-collection.md
+3 -1
View File
@@ -1,5 +1,7 @@
from appwrite.client import Client
from appwrite.services.databases import Databases
from appwrite.permission import Permission
from appwrite.role import Role
client = Client()
client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
@@ -12,7 +14,7 @@ result = databases.update_collection(
database_id = '<DATABASE_ID>',
collection_id = '<COLLECTION_ID>',
name = '<NAME>',
permissions = ["read("any")"], # optional
permissions = [Permission.read(Role.any())], # optional
document_security = False, # optional
enabled = False # optional
)
docs/examples/1.8.x/server-python/examples/databases/update-document.md
+3 -1
View File
@@ -1,5 +1,7 @@
from appwrite.client import Client
from appwrite.services.databases import Databases
from appwrite.permission import Permission
from appwrite.role import Role
client = Client()
client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
@@ -13,6 +15,6 @@ result = databases.update_document(
collection_id = '<COLLECTION_ID>',
document_id = '<DOCUMENT_ID>',
data = {}, # optional
permissions = ["read("any")"], # optional
permissions = [Permission.read(Role.any())], # optional
transaction_id = '<TRANSACTION_ID>' # optional
)
docs/examples/1.8.x/server-python/examples/databases/upsert-document.md
+3 -1
View File
@@ -1,5 +1,7 @@
from appwrite.client import Client
from appwrite.services.databases import Databases
from appwrite.permission import Permission
from appwrite.role import Role
client = Client()
client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
@@ -13,6 +15,6 @@ result = databases.upsert_document(
collection_id = '<COLLECTION_ID>',
document_id = '<DOCUMENT_ID>',
data = {},
permissions = ["read("any")"], # optional
permissions = [Permission.read(Role.any())], # optional
transaction_id = '<TRANSACTION_ID>' # optional
)
docs/examples/1.8.x/server-python/examples/messaging/create-resend-provider.md
+20
View File
@@ -0,0 +1,20 @@
from appwrite.client import Client
from appwrite.services.messaging import Messaging
client = Client()
client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
client.set_project('<YOUR_PROJECT_ID>') # Your project ID
client.set_key('<YOUR_API_KEY>') # Your secret API key
messaging = Messaging(client)
result = messaging.create_resend_provider(
provider_id = '<PROVIDER_ID>',
name = '<NAME>',
api_key = '<API_KEY>', # optional
from_name = '<FROM_NAME>', # optional
from_email = 'email@example.com', # optional
reply_to_name = '<REPLY_TO_NAME>', # optional
reply_to_email = 'email@example.com', # optional
enabled = False # optional
)
docs/examples/1.8.x/server-python/examples/messaging/update-resend-provider.md
+20
View File
@@ -0,0 +1,20 @@
from appwrite.client import Client
from appwrite.services.messaging import Messaging
client = Client()
client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
client.set_project('<YOUR_PROJECT_ID>') # Your project ID
client.set_key('<YOUR_API_KEY>') # Your secret API key
messaging = Messaging(client)
result = messaging.update_resend_provider(
provider_id = '<PROVIDER_ID>',
name = '<NAME>', # optional
enabled = False, # optional
api_key = '<API_KEY>', # optional
from_name = '<FROM_NAME>', # optional
from_email = 'email@example.com', # optional
reply_to_name = '<REPLY_TO_NAME>', # optional
reply_to_email = '<REPLY_TO_EMAIL>' # optional
)
docs/examples/1.8.x/server-python/examples/storage/create-bucket.md
+3 -1
View File
@@ -1,5 +1,7 @@
from appwrite.client import Client
from appwrite.services.storage import Storage
from appwrite.permission import Permission
from appwrite.role import Role
client = Client()
client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
@@ -11,7 +13,7 @@ storage = Storage(client)
result = storage.create_bucket(
bucket_id = '<BUCKET_ID>',
name = '<NAME>',
permissions = ["read("any")"], # optional
permissions = [Permission.read(Role.any())], # optional
file_security = False, # optional
enabled = False, # optional
maximum_file_size = 1, # optional
docs/examples/1.8.x/server-python/examples/storage/create-file.md
+3 -1
View File
@@ -1,6 +1,8 @@
from appwrite.client import Client
from appwrite.services.storage import Storage
from appwrite.input_file import InputFile
from appwrite.permission import Permission
from appwrite.role import Role
client = Client()
client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
@@ -13,5 +15,5 @@ result = storage.create_file(
bucket_id = '<BUCKET_ID>',
file_id = '<FILE_ID>',
file = InputFile.from_path('file.png'),
permissions = ["read("any")"] # optional
permissions = [Permission.read(Role.any())] # optional
)
docs/examples/1.8.x/server-python/examples/storage/update-bucket.md
+3 -1
View File
@@ -1,5 +1,7 @@
from appwrite.client import Client
from appwrite.services.storage import Storage
from appwrite.permission import Permission
from appwrite.role import Role
client = Client()
client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
@@ -11,7 +13,7 @@ storage = Storage(client)
result = storage.update_bucket(
bucket_id = '<BUCKET_ID>',
name = '<NAME>',
permissions = ["read("any")"], # optional
permissions = [Permission.read(Role.any())], # optional
file_security = False, # optional
enabled = False, # optional
maximum_file_size = 1, # optional
docs/examples/1.8.x/server-python/examples/storage/update-file.md
+3 -1
View File
@@ -1,5 +1,7 @@
from appwrite.client import Client
from appwrite.services.storage import Storage
from appwrite.permission import Permission
from appwrite.role import Role
client = Client()
client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
@@ -12,5 +14,5 @@ result = storage.update_file(
bucket_id = '<BUCKET_ID>',
file_id = '<FILE_ID>',
name = '<NAME>', # optional
permissions = ["read("any")"] # optional
permissions = [Permission.read(Role.any())] # optional
)
docs/examples/1.8.x/server-python/examples/tablesdb/create-row.md
+3 -1
View File
@@ -1,5 +1,7 @@
from appwrite.client import Client
from appwrite.services.tables_db import TablesDB
from appwrite.permission import Permission
from appwrite.role import Role
client = Client()
client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
@@ -19,6 +21,6 @@ result = tables_db.create_row(
"age": 30,
"isAdmin": False
},
permissions = ["read("any")"], # optional
permissions = [Permission.read(Role.any())], # optional
transaction_id = '<TRANSACTION_ID>' # optional
)
docs/examples/1.8.x/server-python/examples/tablesdb/create-table.md
+3 -1
View File
@@ -1,5 +1,7 @@
from appwrite.client import Client
from appwrite.services.tables_db import TablesDB
from appwrite.permission import Permission
from appwrite.role import Role
client = Client()
client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
@@ -12,7 +14,7 @@ result = tables_db.create_table(
database_id = '<DATABASE_ID>',
table_id = '<TABLE_ID>',
name = '<NAME>',
permissions = ["read("any")"], # optional
permissions = [Permission.read(Role.any())], # optional
row_security = False, # optional
enabled = False # optional
)
docs/examples/1.8.x/server-python/examples/tablesdb/update-row.md
+3 -1
View File
@@ -1,5 +1,7 @@
from appwrite.client import Client
from appwrite.services.tables_db import TablesDB
from appwrite.permission import Permission
from appwrite.role import Role
client = Client()
client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
@@ -13,6 +15,6 @@ result = tables_db.update_row(
table_id = '<TABLE_ID>',
row_id = '<ROW_ID>',
data = {}, # optional
permissions = ["read("any")"], # optional
permissions = [Permission.read(Role.any())], # optional
transaction_id = '<TRANSACTION_ID>' # optional
)
docs/examples/1.8.x/server-python/examples/tablesdb/update-table.md
+3 -1
View File
@@ -1,5 +1,7 @@
from appwrite.client import Client
from appwrite.services.tables_db import TablesDB
from appwrite.permission import Permission
from appwrite.role import Role
client = Client()
client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
@@ -12,7 +14,7 @@ result = tables_db.update_table(
database_id = '<DATABASE_ID>',
table_id = '<TABLE_ID>',
name = '<NAME>',
permissions = ["read("any")"], # optional
permissions = [Permission.read(Role.any())], # optional
row_security = False, # optional
enabled = False # optional
)
docs/examples/1.8.x/server-python/examples/tablesdb/upsert-row.md
+3 -1
View File
@@ -1,5 +1,7 @@
from appwrite.client import Client
from appwrite.services.tables_db import TablesDB
from appwrite.permission import Permission
from appwrite.role import Role
client = Client()
client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1') # Your API Endpoint
@@ -13,6 +15,6 @@ result = tables_db.upsert_row(
table_id = '<TABLE_ID>',
row_id = '<ROW_ID>',
data = {}, # optional
permissions = ["read("any")"], # optional
permissions = [Permission.read(Role.any())], # optional
transaction_id = '<TRANSACTION_ID>' # optional
)