From 9b1666eeb6ce58f4e8c04cdb6906f9564361bf1f Mon Sep 17 00:00:00 2001 From: Eldad Fux Date: Fri, 1 May 2020 11:48:42 +0300 Subject: [PATCH] Updated docs and added the health API to the server SDKs --- app/config/services.php | 3 ++- docs/services/account.md | 2 +- docs/services/avatars.md | 2 +- docs/services/database.md | 2 +- docs/services/health.md | 1 + docs/services/locale.md | 2 +- docs/services/teams.md | 2 +- docs/services/users.md | 2 +- 8 files changed, 9 insertions(+), 7 deletions(-) create mode 100644 docs/services/health.md diff --git a/app/config/services.php b/app/config/services.php index be0679153f..cc5df8c8e2 100644 --- a/app/config/services.php +++ b/app/config/services.php @@ -43,8 +43,9 @@ return [ ], 'v1/health' => [ 'name' => 'Health', + 'description' => '/docs/services/health.md', 'controller' => 'controllers/api/health.php', - 'sdk' => false, + 'sdk' => true, 'tests' => false, ], 'v1/projects' => [ diff --git a/docs/services/account.md b/docs/services/account.md index ab1f53af87..b69e1a77f1 100644 --- a/docs/services/account.md +++ b/docs/services/account.md @@ -1,4 +1,4 @@ -The account service allows you to authenticate and manage a user account. You can use the account service to update user information, retrieve the user sessions across different devices, and fetch the user security logs with his or her recent activity. +The Account service allows you to authenticate and manage a user account. You can use the account service to update user information, retrieve the user sessions across different devices, and fetch the user security logs with his or her recent activity. You can authenticate the user account by using multiple sign-in methods available. Once the user is authenticated, a new session object will be created to allow the user to access his or her private data and settings. diff --git a/docs/services/avatars.md b/docs/services/avatars.md index 264b476907..9bb9d49f06 100644 --- a/docs/services/avatars.md +++ b/docs/services/avatars.md @@ -1,4 +1,4 @@ -The avatars service aims to help you complete everyday tasks related to your app image, icons, and avatars. +The Avatars service aims to help you complete everyday tasks related to your app image, icons, and avatars. The Avatars service allows you to fetch country flags, browser icons, payment methods logos, remote websites favicons, generate QR codes, and manipulate remote images URLs. diff --git a/docs/services/database.md b/docs/services/database.md index e9b2201407..63f9a9d13f 100644 --- a/docs/services/database.md +++ b/docs/services/database.md @@ -1,4 +1,4 @@ -The database service allows you to create structured collections of documents, query and filter lists of documents, and manage an advanced set of read and write access. +The Database service allows you to create structured collections of documents, query and filter lists of documents, and manage an advanced set of read and write access. All the data in the database service is stored in structured JSON documents. The Appwrite database service also allows you to nest child documents in documents and use advanced filters to both search and query the database just like you would with a classic graph database. diff --git a/docs/services/health.md b/docs/services/health.md new file mode 100644 index 0000000000..1edaf156d8 --- /dev/null +++ b/docs/services/health.md @@ -0,0 +1 @@ +The Health service is designed to allow you to both validate and monitor that your Appwrite server instance and all of its internal components are up and responsive. \ No newline at end of file diff --git a/docs/services/locale.md b/docs/services/locale.md index 81d161146f..8d4796ec2e 100644 --- a/docs/services/locale.md +++ b/docs/services/locale.md @@ -1,3 +1,3 @@ -The locale service allows you to customize your app based on your users' location. Using this service, you can get your users' location, IP address, list of countries and continents names, phone codes, currencies, and more. +The Locale service allows you to customize your app based on your users' location. Using this service, you can get your users' location, IP address, list of countries and continents names, phone codes, currencies, and more. The user service supports multiple locales. This feature allows you to fetch countries and continents information in your app language. To switch locales, all you need to do is pass the 'X-Appwrite-Locale' header or set the 'setLocale' method using any of our available SDKs. [View here the list of available locales](https://github.com/appwrite/appwrite/blob/master/app/config/locales.php). diff --git a/docs/services/teams.md b/docs/services/teams.md index 377defaf7a..7ed13771b7 100644 --- a/docs/services/teams.md +++ b/docs/services/teams.md @@ -1,4 +1,4 @@ -The teams' service allows you to group users of your project and to enable them to share [read and write](/docs/permissions) access to your project resources, such as database documents or storage files. +The Teams service allows you to group users of your project and to enable them to share [read and write](/docs/permissions) access to your project resources, such as database documents or storage files. Each user who creates a team becomes the team owner and can delegate the ownership role by inviting a new team member. Only team owners can invite new users to their team. \ No newline at end of file diff --git a/docs/services/users.md b/docs/services/users.md index 2d38476e1a..06c799aa2c 100644 --- a/docs/services/users.md +++ b/docs/services/users.md @@ -1 +1 @@ -The users' service allows you to manage your project users. Use this service to search, block, and view your users' info, current sessions, and latest activity logs. You can also use the Users service to edit your users' preferences and personal info. \ No newline at end of file +The Users service allows you to manage your project users. Use this service to search, block, and view your users' info, current sessions, and latest activity logs. You can also use the Users service to edit your users' preferences and personal info. \ No newline at end of file