Merge pull request #790 from appwrite/feat-update-function-docs

Updated docs

app/controllers/api/functions.php

@@ -313,7 +313,7 @@ App::patch('/v1/functions/:functionId/tag')
     ->label('sdk.platform', [APP_PLATFORM_SERVER])
     ->label('sdk.namespace', 'functions')
     ->label('sdk.method', 'updateTag')
-    ->label('sdk.description', '/docs/references/functions/update-tag.md')
+    ->label('sdk.description', '/docs/references/functions/update-function-tag.md')
     ->label('sdk.response.code', Response::STATUS_CODE_OK)
     ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
     ->label('sdk.response.model', Response::MODEL_FUNCTION)

docs/references/avatars/get-credit-card.md

@@ -1 +1 @@
-Need to display your users with your billing method or their payment methods? The credit card endpoint will return you the icon of the credit card provider you need. Use width, height and quality arguments to change the output settings.
+The credit card endpoint will return you the icon of the credit card provider you need. Use width, height and quality arguments to change the output settings.

docs/references/database/list-collections.md

@@ -1 +1 @@
-Get a list of all the user collections. You can use the query params to filter your results. On admin mode, this endpoint will return a list of all of the project collections. [Learn more about different API modes](/docs/admin).
+Get a list of all the user collections. You can use the query params to filter your results. On admin mode, this endpoint will return a list of all of the project's collections. [Learn more about different API modes](/docs/admin).

docs/references/database/list-documents.md

@@ -1 +1 @@
-Get a list of all the user documents. You can use the query params to filter your results. On admin mode, this endpoint will return a list of all of the project documents. [Learn more about different API modes](/docs/admin).
+Get a list of all the user documents. You can use the query params to filter your results. On admin mode, this endpoint will return a list of all of the project's documents. [Learn more about different API modes](/docs/admin).

docs/references/functions/create-execution.md

@@ -0,0 +1 @@
+Trigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.

docs/references/functions/create-function.md

@@ -0,0 +1 @@
+Create a new function. You can pass a list of [permissions](/docs/permissions) to allow different project users or team with access to execute the function using the client API.

docs/references/functions/create-tag.md

@@ -0,0 +1,5 @@
+Create a new function code tag. Use this endpoint to upload a new version of your code function. To execute your newly uploaded code, you'll need to update the function's tag to use your new tag UID.
+
+This endpoint accepts a tar.gz file compressed with your code. Make sure to include any dependencies your code has within the compressed file. You can learn more about code packaging in the [Appwrite Cloud Functions tutorial](/docs/functions).
+
+Use the "command" param to set the entry point used to execute your code.

docs/references/functions/delete-function.md

@@ -0,0 +1 @@
+Delete a function by its unique ID.

docs/references/functions/delete-tag.md

@@ -0,0 +1 @@
+Delete a code tag by its unique ID.

docs/references/functions/get-execution.md

@@ -0,0 +1 @@
+Get a function execution log by its unique ID.

docs/references/functions/get-function.md

@@ -0,0 +1 @@
+Get a function by its unique ID.

docs/references/functions/get-tag.md

@@ -0,0 +1 @@
+Get a code tag by its unique ID.

docs/references/functions/list-executions.md

@@ -0,0 +1 @@
+Get a list of all the current user function execution logs. You can use the query params to filter your results. On admin mode, this endpoint will return a list of all of the project's teams. [Learn more about different API modes](/docs/admin).

docs/references/functions/list-functions.md

@@ -0,0 +1 @@
+Get a list of all the project's functions. You can use the query params to filter your results.

docs/references/functions/list-tags.md

@@ -0,0 +1 @@
+Get a list of all the project's code tags. You can use the query params to filter your results.

docs/references/functions/update-function-tag.md

@@ -0,0 +1 @@
+Update the function code tag ID using the unique function ID. Use this endpoint to switch the code tag that should be executed by the execution endpoint.

docs/references/functions/update-function.md

@@ -0,0 +1 @@
+Update function by its unique ID.

docs/references/storage/get-file-download.md

@@ -1 +1 @@
-Get file content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.
+Get a file content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.

docs/references/storage/get-file-view.md

@@ -1 +1 @@
-Get file content by its unique ID. This endpoint is similar to the download method but returns with no  'Content-Disposition: attachment' header.
+Get a file content by its unique ID. This endpoint is similar to the download method but returns with no  'Content-Disposition: attachment' header.

docs/references/storage/get-file.md

@@ -1 +1 @@
-Get file by its unique ID. This endpoint response returns a JSON object with the file metadata.
+Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.

docs/references/storage/list-files.md

@@ -1 +1 @@
-Get a list of all the user files. You can use the query params to filter your results. On admin mode, this endpoint will return a list of all of the project files. [Learn more about different API modes](/docs/admin).
+Get a list of all the user files. You can use the query params to filter your results. On admin mode, this endpoint will return a list of all of the project's files. [Learn more about different API modes](/docs/admin).

docs/references/storage/update-file.md

@@ -1 +1 @@
-Update file by its unique ID. Only users with write permissions have access to update this resource.
+Update a file by its unique ID. Only users with write permissions have access to update this resource.

docs/references/teams/delete-team.md

@@ -1 +1 @@
-Delete team by its unique ID. Only team owners have write access for this resource.
+Delete a team by its unique ID. Only team owners have write access for this resource.

docs/references/teams/get-team-members.md

@@ -1 +1 @@
-Get team members by the team unique ID. All team members have read access for this list of resources.
+Get a team members by the team unique ID. All team members have read access for this list of resources.

docs/references/teams/get-team.md

@@ -1 +1 @@
-Get team by its unique ID. All team members have read access for this resource.
+Get a team by its unique ID. All team members have read access for this resource.

docs/references/teams/list-teams.md

@@ -1 +1 @@
-Get a list of all the current user teams. You can use the query params to filter your results. On admin mode, this endpoint will return a list of all of the project teams. [Learn more about different API modes](/docs/admin).
+Get a list of all the current user teams. You can use the query params to filter your results. On admin mode, this endpoint will return a list of all of the project's teams. [Learn more about different API modes](/docs/admin).

docs/references/teams/update-team.md

@@ -1 +1 @@
-Update team by its unique ID. Only team owners have write access for this resource.
+Update a team by its unique ID. Only team owners have write access for this resource.

docs/references/users/delete-user-session.md

@@ -1 +1 @@
-Delete user sessions by its unique ID.
+Delete a user sessions by its unique ID.

docs/references/users/delete-user-sessions.md

@@ -1 +1 @@
-Delete all user sessions by its unique ID.
+Delete all user's sessions by using the user's unique ID.

docs/references/users/get-user-logs.md

@@ -1 +1 @@
-Get user activity logs list by its unique ID.
+Get a user activity logs list by its unique ID.

docs/references/users/get-user-prefs.md

@@ -1 +1 @@
-Get user preferences by its unique ID.
+Get the user preferences by its unique ID.

docs/references/users/get-user-sessions.md

@@ -1 +1 @@
-Get user sessions list by its unique ID.
+Get the user sessions list by its unique ID.

docs/references/users/get-user.md

@@ -1 +1 @@
-Get user by its unique ID.
+Get a user by its unique ID.

docs/references/users/list-users.md

@@ -1 +1 @@
-Get a list of all the project users. You can use the query params to filter your results.
+Get a list of all the project's users. You can use the query params to filter your results.

docs/references/users/update-user-prefs.md

@@ -1 +1 @@
-Update user preferences by its unique ID. You can pass only the specific settings you wish to update.
+Update the user preferences by its unique ID. You can pass only the specific settings you wish to update.

docs/references/users/update-user-status.md

@@ -1 +1 @@
-Update user status by its unique ID.
+Update the user status by its unique ID.