Skip to content

Commit 065b84f

Browse files
Merge pull request #11 from appwrite/dev
feat: update for 1.0.0-RC1
2 parents 46f5706 + f5e24b0 commit 065b84f

File tree

9 files changed

+31
-31
lines changed

9 files changed

+31
-31
lines changed

appwrite.gemspec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Gem::Specification.new do |spec|
22

33
spec.name = 'appwrite'
4-
spec.version = '7.0.0-RC1'
4+
spec.version = '7.0.0-RC2'
55
spec.license = 'BSD-3-Clause'
66
spec.summary = 'Appwrite is an open-source self-hosted backend server that abstract and simplify complex and repetitive development tasks behind a very simple REST API'
77
spec.author = 'Appwrite Team'

lib/appwrite/client.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ def initialize
1515
'x-sdk-name'=> 'Ruby',
1616
'x-sdk-platform'=> 'server',
1717
'x-sdk-language'=> 'ruby',
18-
'x-sdk-version'=> '7.0.0-RC1',
18+
'x-sdk-version'=> '7.0.0-RC2',
1919
'X-Appwrite-Response-Format' => '1.0.0-RC1'
2020
}
2121
@endpoint = 'https://HOSTNAME/v1'

lib/appwrite/services/account.rb

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ def update_password(password:, old_password: nil)
176176
# /account/verification/phone](/docs/client/account#accountCreatePhoneVerification)
177177
# endpoint to send a confirmation SMS.
178178
#
179-
# @param [String] phone Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
179+
# @param [String] phone Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
180180
# @param [String] password User password. Must be at least 8 chars.
181181
#
182182
# @return [Account]
@@ -424,7 +424,7 @@ def delete_sessions()
424424
# Use this endpoint to get a logged in user's session using a Session ID.
425425
# Inputting 'current' will return the current session being used.
426426
#
427-
# @param [String] session_id Session ID. Use the string 'current' to get the current device session.
427+
# @param [String] session_id Session ID. Use the string 'current' to get the current device session.
428428
#
429429
# @return [Session]
430430
def get_session(session_id:)
@@ -457,7 +457,7 @@ def get_session(session_id:)
457457
# If session was created using an OAuth provider, this route can be used to
458458
# "refresh" the access token.
459459
#
460-
# @param [String] session_id Session ID. Use the string 'current' to update the current device session.
460+
# @param [String] session_id Session ID. Use the string 'current' to update the current device session.
461461
#
462462
# @return [Session]
463463
def update_session(session_id:)
@@ -491,7 +491,7 @@ def update_session(session_id:)
491491
# Session ID argument, only the unique session ID provided is deleted.
492492
#
493493
#
494-
# @param [String] session_id Session ID. Use the string 'current' to delete the current device session.
494+
# @param [String] session_id Session ID. Use the string 'current' to delete the current device session.
495495
#
496496
# @return []
497497
def delete_session(session_id:)

lib/appwrite/services/avatars.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ def get_initials(name: nil, width: nil, height: nil, background: nil)
269269
# @param [String] text Plain text to be converted to QR code image.
270270
# @param [Integer] size QR code size. Pass an integer between 1 to 1000. Defaults to 400.
271271
# @param [Integer] margin Margin from edge. Pass an integer between 0 to 10. Defaults to 1.
272-
# @param [] download Return resulting image with 'Content-Disposition: attachment ' headers for the browser to start downloading it. Pass 0 for no header, or 1 for otherwise. Default value is set to 0.
272+
# @param [] download Return resulting image with 'Content-Disposition: attachment ' headers for the browser to start downloading it. Pass 0 for no header, or 1 for otherwise. Default value is set to 0.
273273
#
274274
# @return []
275275
def get_qr(text:, size: nil, margin: nil, download: nil)

lib/appwrite/services/databases.rb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ def list(queries: nil, search: nil)
4040
# Create a new Database.
4141
#
4242
#
43-
# @param [String] database_id Unique Id. Choose your own unique ID or pass the string "unique()" to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
43+
# @param [String] database_id Unique Id. Choose your own unique ID or pass the string "unique()" to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
4444
# @param [String] name Collection name. Max length: 128 chars.
4545
#
4646
# @return [Database]
@@ -217,7 +217,7 @@ def list_collections(database_id:, queries: nil, search: nil)
217217
# directly from your database console.
218218
#
219219
# @param [String] database_id Database ID.
220-
# @param [String] collection_id Unique Id. Choose your own unique ID or pass the string "unique()" to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
220+
# @param [String] collection_id Unique Id. Choose your own unique ID or pass the string "unique()" to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
221221
# @param [String] name Collection name. Max length: 128 chars.
222222
# @param [Array] permissions An array of permissions strings. By default no user is granted with any permissions. [Learn more about permissions](/docs/permissions).
223223
# @param [] document_security Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](/docs/permissions).
@@ -1061,7 +1061,7 @@ def list_documents(database_id:, collection_id:, queries: nil)
10611061
#
10621062
# @param [String] database_id Database ID.
10631063
# @param [String] collection_id Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection). Make sure to define attributes before creating documents.
1064-
# @param [String] document_id Document ID. Choose your own unique ID or pass the string "unique()" to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
1064+
# @param [String] document_id Document ID. Choose your own unique ID or pass the string "unique()" to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
10651065
# @param [Hash] data Document data as JSON object.
10661066
# @param [Array] permissions An array of permissions strings. By default the current user is granted with all permissions. [Learn more about permissions](/docs/permissions).
10671067
#

lib/appwrite/services/functions.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ def list(queries: nil, search: nil)
4141
# [permissions](/docs/permissions) to allow different project users or team
4242
# with access to execute the function using the client API.
4343
#
44-
# @param [String] function_id Function ID. Choose your own unique ID or pass the string "unique()" to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
44+
# @param [String] function_id Function ID. Choose your own unique ID or pass the string "unique()" to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
4545
# @param [String] name Function name. Max length: 128 chars.
4646
# @param [Array] execute An array of strings with execution roles. By default no user is granted with any execute permissions. [learn more about permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 64 characters long.
4747
# @param [String] runtime Execution runtime.

lib/appwrite/services/storage.rb

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -39,16 +39,16 @@ def list_buckets(queries: nil, search: nil)
3939

4040
# Create a new storage bucket.
4141
#
42-
# @param [String] bucket_id Unique Id. Choose your own unique ID or pass the string `unique()` to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
42+
# @param [String] bucket_id Unique Id. Choose your own unique ID or pass the string `unique()` to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
4343
# @param [String] name Bucket name
4444
# @param [Array] permissions An array of permission strings. By default no user is granted with any permissions. [Learn more about permissions](/docs/permissions).
4545
# @param [] file_security Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](/docs/permissions).
4646
# @param [] enabled Is bucket enabled?
4747
# @param [Integer] maximum_file_size Maximum file size allowed in bytes. Maximum allowed value is 30MB. For self-hosted setups you can change the max limit by changing the `_APP_STORAGE_LIMIT` environment variable. [Learn more about storage environment variables](docs/environment-variables#storage)
4848
# @param [Array] allowed_file_extensions Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.
49-
# @param [String] compression Compression algorithm choosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
50-
# @param [] encryption Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
51-
# @param [] antivirus Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
49+
# @param [String] compression Compression algorithm choosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
50+
# @param [] encryption Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
51+
# @param [] antivirus Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
5252
#
5353
# @return [Bucket]
5454
def create_bucket(bucket_id:, name:, permissions: nil, file_security: nil, enabled: nil, maximum_file_size: nil, allowed_file_extensions: nil, compression: nil, encryption: nil, antivirus: nil)
@@ -131,9 +131,9 @@ def get_bucket(bucket_id:)
131131
# @param [] enabled Is bucket enabled?
132132
# @param [Integer] maximum_file_size Maximum file size allowed in bytes. Maximum allowed value is 30MB. For self hosted version you can change the limit by changing _APP_STORAGE_LIMIT environment variable. [Learn more about storage environment variables](docs/environment-variables#storage)
133133
# @param [Array] allowed_file_extensions Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.
134-
# @param [String] compression Compression algorithm choosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
135-
# @param [] encryption Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
136-
# @param [] antivirus Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
134+
# @param [String] compression Compression algorithm choosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
135+
# @param [] encryption Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
136+
# @param [] antivirus Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
137137
#
138138
# @return [Bucket]
139139
def update_bucket(bucket_id:, name:, permissions: nil, file_security: nil, enabled: nil, maximum_file_size: nil, allowed_file_extensions: nil, compression: nil, encryption: nil, antivirus: nil)
@@ -262,7 +262,7 @@ def list_files(bucket_id:, queries: nil, search: nil)
262262
#
263263
#
264264
# @param [String] bucket_id Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](/docs/server/storage#createBucket).
265-
# @param [String] file_id File ID. Choose your own unique ID or pass the string "unique()" to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
265+
# @param [String] file_id File ID. Choose your own unique ID or pass the string "unique()" to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
266266
# @param [file] file Binary file.
267267
# @param [Array] permissions An array of permission strings. By default the current user is granted with all permissions. [Learn more about permissions](/docs/permissions).
268268
#

lib/appwrite/services/teams.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ def list(queries: nil, search: nil)
4444
# assigned as the owner of the team. Only the users with the owner role can
4545
# invite new members, add new owners and delete or update the team.
4646
#
47-
# @param [String] team_id Team ID. Choose your own unique ID or pass the string "unique()" to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
47+
# @param [String] team_id Team ID. Choose your own unique ID or pass the string "unique()" to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
4848
# @param [String] name Team name. Max length: 128 chars.
4949
# @param [Array] roles Array of strings. Use this param to set the roles in the team for the user who created it. The default role is **owner**. A role can be any string. Learn more about [roles and permissions](/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.
5050
#
@@ -326,7 +326,7 @@ def get_membership(team_id:, membership_id:)
326326
#
327327
# @param [String] team_id Team ID.
328328
# @param [String] membership_id Membership ID.
329-
# @param [Array] roles An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.
329+
# @param [Array] roles An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.
330330
#
331331
# @return [Membership]
332332
def update_membership_roles(team_id:, membership_id:, roles:)

0 commit comments

Comments
 (0)