Skip to content

Commit 456248e

Browse files
committed
Initial commit
1 parent 01e6c67 commit 456248e

File tree

6 files changed

+22
-15
lines changed

6 files changed

+22
-15
lines changed

docs/auth.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,13 @@ When accessing this route using Javascript from the browser, success and failure
2727
GET https://appwrite.io/v1/auth/login/oauth/{provider}
2828
```
2929

30+
** Allow the user to login to his account using the OAuth provider of his choice. Each OAuth provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed. **
31+
3032
### Parameters
3133

3234
| Field Name | Type | Description | Default |
3335
| --- | --- | --- | --- |
34-
| provider | string | **Required** OAuth Provider | |
36+
| provider | string | **Required** OAuth Provider. Currently, supported providers are: bitbucket, facebook, github, gitlab, google, microsoft, linkedin, slack, dropbox, amazon, vk | |
3537
| success | string | **Required** URL to redirect back to your app after a successful login attempt. | |
3638
| failure | string | **Required** URL to redirect back to your app after a failed login attempt. | |
3739

docs/database.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ POST https://appwrite.io/v1/database
3030
| Field Name | Type | Description | Default |
3131
| --- | --- | --- | --- |
3232
| name | string | Collection name. | |
33-
| read | array | An array of strings with read permissions. By default no user is granted with any read permissions. [learn more about permissions and roles](/docs/permissions) and get a full list of available permissions. | |
34-
| write | array | An array of strings with write permissions. By default no user is granted with any write permissions. [learn more about permissions and roles](/docs/permissions) and get a full list of available permissions. | |
33+
| read | array | An array of strings with read permissions. By default no user is granted with any read permissions. [learn more about permissions](/docs/permissions) and get a full list of available permissions. | |
34+
| write | array | An array of strings with write permissions. By default no user is granted with any write permissions. [learn more about permissions](/docs/permissions) and get a full list of available permissions. | |
3535
| rules | array | Array of [rule objects](/docs/rules). Each rule define a collection field name, data type and validation | |
3636

3737
## Get Collection
@@ -62,8 +62,8 @@ PUT https://appwrite.io/v1/database/{collectionId}
6262
| --- | --- | --- | --- |
6363
| collectionId | string | **Required** Collection unique ID. | |
6464
| name | string | Collection name. | |
65-
| read | array | An array of strings with read permissions. By default no user is granted with any read permissions. [learn more about permissions and roles](/docs/permissions) and get a full list of available permissions. | |
66-
| write | array | An array of strings with write permissions. By default no user is granted with any write permissions. [learn more about permissions and roles](/docs/permissions) and get a full list of available permissions. | |
65+
| read | array | An array of strings with read permissions. By default no user is granted with any read permissions. [learn more about permissions(/docs/permissions) and get a full list of available permissions. | |
66+
| write | array | An array of strings with write permissions. By default no user is granted with any write permissions. [learn more about permissions](/docs/permissions) and get a full list of available permissions. | |
6767
| rules | array | Array of [rule objects](/docs/rules). Each rule define a collection field name, data type and validation | [] |
6868

6969
## Delete Collection
@@ -117,8 +117,8 @@ POST https://appwrite.io/v1/database/{collectionId}/documents
117117
| --- | --- | --- | --- |
118118
| collectionId | string | **Required** Collection unique ID. | |
119119
| data | string | Document data as JSON string. | |
120-
| read | array | An array of strings with read permissions. By default no user is granted with any read permissions. [learn more about permissions and roles](/docs/permissions) and get a full list of available permissions. | |
121-
| write | array | An array of strings with write permissions. By default no user is granted with any write permissions. [learn more about permissions and roles](/docs/permissions) and get a full list of available permissions. | |
120+
| read | array | An array of strings with read permissions. By default no user is granted with any read permissions. [learn more about permissions](/docs/permissions) and get a full list of available permissions. | |
121+
| write | array | An array of strings with write permissions. By default no user is granted with any write permissions. [learn more about permissions](/docs/permissions) and get a full list of available permissions. | |
122122
| parentDocument | string | Parent document unique ID. Use when you want your new document to be a child of a parent document. | |
123123
| parentProperty | string | Parent document property name. Use when you want your new document to be a child of a parent document. | |
124124
| parentPropertyType | string | Parent document property connection type. You can set this value to **assign**, **append** or **prepend**, default value is assign. Use when you want your new document to be a child of a parent document. | assign |
@@ -151,8 +151,8 @@ PATCH https://appwrite.io/v1/database/{collectionId}/documents/{documentId}
151151
| collectionId | string | **Required** Collection unique ID | |
152152
| documentId | string | **Required** Document unique ID | |
153153
| data | string | Document data as JSON string | |
154-
| read | array | An array of strings with read permissions. By default no user is granted with any read permissions. [learn more about permissions and roles](/docs/permissions) and get a full list of available permissions. | |
155-
| write | array | An array of strings with write permissions. By default no user is granted with any write permissions. [learn more about permissions and roles](/docs/permissions) and get a full list of available permissions. | |
154+
| read | array | An array of strings with read permissions. By default no user is granted with any read permissions. [learn more about permissions](/docs/permissions) and get a full list of available permissions. | |
155+
| write | array | An array of strings with write permissions. By default no user is granted with any write permissions. [learn more about permissions](/docs/permissions) and get a full list of available permissions. | |
156156

157157
## Delete Document
158158

docs/locale.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ GET https://appwrite.io/v1/locale/countries/phones
4040

4141
** List of all countries phone codes. You can use the locale header to get the data in a supported language. **
4242

43-
## List of currencies
43+
## List Currencies
4444

4545
```http request
4646
GET https://appwrite.io/v1/locale/currencies

docs/storage.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ POST https://appwrite.io/v1/storage/files
3030
| Field Name | Type | Description | Default |
3131
| --- | --- | --- | --- |
3232
| files | file | Binary Files. | |
33-
| read | array | An array of strings with read permissions. By default no user is granted with any read permissions. [learn more about permissions and roles](/docs/permissions) and get a full list of available permissions. | |
34-
| write | array | An array of strings with write permissions. By default no user is granted with any write permissions. [learn more about permissions and roles](/docs/permissions) and get a full list of available permissions. | |
33+
| read | array | An array of strings with read permissions. By default no user is granted with any read permissions. [learn more about permissions](/docs/permissions) and get a full list of available permissions. | |
34+
| write | array | An array of strings with write permissions. By default no user is granted with any write permissions. [learn more about permissions](/docs/permissions) and get a full list of available permissions. | |
3535
| folderId | string | Folder to associate files with. | |
3636

3737
## Get File
@@ -61,8 +61,8 @@ PUT https://appwrite.io/v1/storage/files/{fileId}
6161
| Field Name | Type | Description | Default |
6262
| --- | --- | --- | --- |
6363
| fileId | string | **Required** File unique ID. | |
64-
| read | array | An array of strings with read permissions. By default no user is granted with any read permissions. [learn more about permissions and roles](/docs/permissions) and get a full list of available permissions. | |
65-
| write | array | An array of strings with write permissions. By default no user is granted with any write permissions. [learn more about permissions and roles](/docs/permissions) and get a full list of available permissions. | |
64+
| read | array | An array of strings with read permissions. By default no user is granted with any read permissions. [learn more about permissions](/docs/permissions) and get a full list of available permissions. | |
65+
| write | array | An array of strings with write permissions. By default no user is granted with any write permissions. [learn more about permissions](/docs/permissions) and get a full list of available permissions. | |
6666
| folderId | string | Folder to associate files with. | |
6767

6868
## Delete File

src/Appwrite/Services/Auth.php

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,11 @@ public function login(string $email, string $password, string $success = '', str
5151
/**
5252
* Login with OAuth
5353
*
54+
* Allow the user to login to his account using the OAuth provider of his
55+
* choice. Each OAuth provider should be enabled from the Appwrite console
56+
* first. Use the success and failure arguments to provide a redirect URL's
57+
* back to your app when login is completed.
58+
*
5459
* @param string $provider
5560
* @param string $success
5661
* @param string $failure

src/Appwrite/Services/Locale.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ public function getCountriesPhones():array
112112
}
113113

114114
/**
115-
* List of currencies
115+
* List Currencies
116116
*
117117
* List of all currencies, including currency symol, name, plural, and decimal
118118
* digits for all major and minor currencies. You can use the locale header to

0 commit comments

Comments
 (0)