CodeMirror/appwrite
1
0
Fork 0
mirror of synced 2024-05-21 05:02:37 +12:00
Code Issues Projects Releases Wiki Activity

Updated docs and added the health API to the server SDKs

Browse source
This commit is contained in:
Eldad Fux 2020-05-01 11:48:42 +03:00
parent 7d620baaf2
commit 9b1666eeb6
8 changed files with 9 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
app/config/services.php
View file

@ -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' => [

2
docs/services/account.md
View file

@ -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.

2
docs/services/avatars.md
View file

@ -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.

2
docs/services/database.md
View file

@ -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.

1
docs/services/health.md Normal file
View file

@ -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.

2
docs/services/locale.md
View file

@ -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).

2
docs/services/teams.md
View file

@ -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.

2
docs/services/users.md
View file

@ -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.
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.