From 05b510786e908a557aec78faf1bf27d68ea4a00e Mon Sep 17 00:00:00 2001 From: Eldad Fux Date: Thu, 31 Dec 2020 10:25:11 +0200 Subject: [PATCH] Updated docs --- app/controllers/api/functions.php | 2 +- docs/references/avatars/get-credit-card.md | 2 +- docs/references/database/list-collections.md | 2 +- docs/references/database/list-documents.md | 2 +- docs/references/functions/create-execution.md | 1 + docs/references/functions/create-function.md | 1 + docs/references/functions/create-tag.md | 5 +++++ docs/references/functions/delete-function.md | 1 + docs/references/functions/delete-tag.md | 1 + docs/references/functions/get-execution.md | 1 + docs/references/functions/get-function.md | 1 + docs/references/functions/get-tag.md | 1 + docs/references/functions/list-executions.md | 1 + docs/references/functions/list-functions.md | 1 + docs/references/functions/list-tags.md | 1 + docs/references/functions/update-function-tag.md | 1 + docs/references/functions/update-function.md | 1 + docs/references/storage/get-file-download.md | 2 +- docs/references/storage/get-file-view.md | 2 +- docs/references/storage/get-file.md | 2 +- docs/references/storage/list-files.md | 2 +- docs/references/storage/update-file.md | 2 +- docs/references/teams/delete-team.md | 2 +- docs/references/teams/get-team-members.md | 2 +- docs/references/teams/get-team.md | 2 +- docs/references/teams/list-teams.md | 2 +- docs/references/teams/update-team.md | 2 +- docs/references/users/delete-user-session.md | 2 +- docs/references/users/delete-user-sessions.md | 2 +- docs/references/users/get-user-logs.md | 2 +- docs/references/users/get-user-prefs.md | 2 +- docs/references/users/get-user-sessions.md | 2 +- docs/references/users/get-user.md | 2 +- docs/references/users/list-users.md | 2 +- docs/references/users/update-user-prefs.md | 2 +- docs/references/users/update-user-status.md | 2 +- 36 files changed, 40 insertions(+), 23 deletions(-) create mode 100644 docs/references/functions/create-execution.md create mode 100644 docs/references/functions/create-function.md create mode 100644 docs/references/functions/create-tag.md create mode 100644 docs/references/functions/delete-function.md create mode 100644 docs/references/functions/delete-tag.md create mode 100644 docs/references/functions/get-execution.md create mode 100644 docs/references/functions/get-function.md create mode 100644 docs/references/functions/get-tag.md create mode 100644 docs/references/functions/list-executions.md create mode 100644 docs/references/functions/list-functions.md create mode 100644 docs/references/functions/list-tags.md create mode 100644 docs/references/functions/update-function-tag.md create mode 100644 docs/references/functions/update-function.md diff --git a/app/controllers/api/functions.php b/app/controllers/api/functions.php index da5572e80d..1885ef72b3 100644 --- a/app/controllers/api/functions.php +++ b/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) diff --git a/docs/references/avatars/get-credit-card.md b/docs/references/avatars/get-credit-card.md index e0b3e97ace..8e7fb59bbd 100644 --- a/docs/references/avatars/get-credit-card.md +++ b/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. \ No newline at end of file +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. \ No newline at end of file diff --git a/docs/references/database/list-collections.md b/docs/references/database/list-collections.md index b71a823f0b..1cf18ef8b9 100644 --- a/docs/references/database/list-collections.md +++ b/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). \ No newline at end of file +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). \ No newline at end of file diff --git a/docs/references/database/list-documents.md b/docs/references/database/list-documents.md index 8d8edbdb85..7c93be3a63 100644 --- a/docs/references/database/list-documents.md +++ b/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). \ No newline at end of file +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). \ No newline at end of file diff --git a/docs/references/functions/create-execution.md b/docs/references/functions/create-execution.md new file mode 100644 index 0000000000..6089c4ff01 --- /dev/null +++ b/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. \ No newline at end of file diff --git a/docs/references/functions/create-function.md b/docs/references/functions/create-function.md new file mode 100644 index 0000000000..1461b06e0f --- /dev/null +++ b/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. \ No newline at end of file diff --git a/docs/references/functions/create-tag.md b/docs/references/functions/create-tag.md new file mode 100644 index 0000000000..15f1bb1c65 --- /dev/null +++ b/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. \ No newline at end of file diff --git a/docs/references/functions/delete-function.md b/docs/references/functions/delete-function.md new file mode 100644 index 0000000000..92835e3c82 --- /dev/null +++ b/docs/references/functions/delete-function.md @@ -0,0 +1 @@ +Delete a function by its unique ID. \ No newline at end of file diff --git a/docs/references/functions/delete-tag.md b/docs/references/functions/delete-tag.md new file mode 100644 index 0000000000..698ecc8927 --- /dev/null +++ b/docs/references/functions/delete-tag.md @@ -0,0 +1 @@ +Delete a code tag by its unique ID. \ No newline at end of file diff --git a/docs/references/functions/get-execution.md b/docs/references/functions/get-execution.md new file mode 100644 index 0000000000..fc38260bdb --- /dev/null +++ b/docs/references/functions/get-execution.md @@ -0,0 +1 @@ +Get a function execution log by its unique ID. \ No newline at end of file diff --git a/docs/references/functions/get-function.md b/docs/references/functions/get-function.md new file mode 100644 index 0000000000..557ec316ba --- /dev/null +++ b/docs/references/functions/get-function.md @@ -0,0 +1 @@ +Get a function by its unique ID. \ No newline at end of file diff --git a/docs/references/functions/get-tag.md b/docs/references/functions/get-tag.md new file mode 100644 index 0000000000..804e1bc87f --- /dev/null +++ b/docs/references/functions/get-tag.md @@ -0,0 +1 @@ +Get a code tag by its unique ID. \ No newline at end of file diff --git a/docs/references/functions/list-executions.md b/docs/references/functions/list-executions.md new file mode 100644 index 0000000000..82faa3b913 --- /dev/null +++ b/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). \ No newline at end of file diff --git a/docs/references/functions/list-functions.md b/docs/references/functions/list-functions.md new file mode 100644 index 0000000000..9ad432fdc0 --- /dev/null +++ b/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. \ No newline at end of file diff --git a/docs/references/functions/list-tags.md b/docs/references/functions/list-tags.md new file mode 100644 index 0000000000..d872894a64 --- /dev/null +++ b/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. \ No newline at end of file diff --git a/docs/references/functions/update-function-tag.md b/docs/references/functions/update-function-tag.md new file mode 100644 index 0000000000..5d38628682 --- /dev/null +++ b/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. \ No newline at end of file diff --git a/docs/references/functions/update-function.md b/docs/references/functions/update-function.md new file mode 100644 index 0000000000..5a9a84ad94 --- /dev/null +++ b/docs/references/functions/update-function.md @@ -0,0 +1 @@ +Update function by its unique ID. \ No newline at end of file diff --git a/docs/references/storage/get-file-download.md b/docs/references/storage/get-file-download.md index 11cb96a9f5..044d58340f 100644 --- a/docs/references/storage/get-file-download.md +++ b/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. \ No newline at end of file +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. \ No newline at end of file diff --git a/docs/references/storage/get-file-view.md b/docs/references/storage/get-file-view.md index 4bb5abb3c7..1263364b15 100644 --- a/docs/references/storage/get-file-view.md +++ b/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. \ No newline at end of file +Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header. \ No newline at end of file diff --git a/docs/references/storage/get-file.md b/docs/references/storage/get-file.md index 56db5c8457..0b7069ae57 100644 --- a/docs/references/storage/get-file.md +++ b/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. \ No newline at end of file +Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata. \ No newline at end of file diff --git a/docs/references/storage/list-files.md b/docs/references/storage/list-files.md index 39cb76750b..9bf3618974 100644 --- a/docs/references/storage/list-files.md +++ b/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). \ No newline at end of file +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). \ No newline at end of file diff --git a/docs/references/storage/update-file.md b/docs/references/storage/update-file.md index abc44a782c..461c137c5c 100644 --- a/docs/references/storage/update-file.md +++ b/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. \ No newline at end of file +Update a file by its unique ID. Only users with write permissions have access to update this resource. \ No newline at end of file diff --git a/docs/references/teams/delete-team.md b/docs/references/teams/delete-team.md index a9e48c5a43..887dfcc06f 100644 --- a/docs/references/teams/delete-team.md +++ b/docs/references/teams/delete-team.md @@ -1 +1 @@ -Delete team by its unique ID. Only team owners have write access for this resource. \ No newline at end of file +Delete a team by its unique ID. Only team owners have write access for this resource. \ No newline at end of file diff --git a/docs/references/teams/get-team-members.md b/docs/references/teams/get-team-members.md index b5a33667d9..ee939b9978 100644 --- a/docs/references/teams/get-team-members.md +++ b/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. \ No newline at end of file +Get a team members by the team unique ID. All team members have read access for this list of resources. \ No newline at end of file diff --git a/docs/references/teams/get-team.md b/docs/references/teams/get-team.md index eda8865e78..800612ab15 100644 --- a/docs/references/teams/get-team.md +++ b/docs/references/teams/get-team.md @@ -1 +1 @@ -Get team by its unique ID. All team members have read access for this resource. \ No newline at end of file +Get a team by its unique ID. All team members have read access for this resource. \ No newline at end of file diff --git a/docs/references/teams/list-teams.md b/docs/references/teams/list-teams.md index 8df8128b8c..04a3959e4c 100644 --- a/docs/references/teams/list-teams.md +++ b/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). \ No newline at end of file +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). \ No newline at end of file diff --git a/docs/references/teams/update-team.md b/docs/references/teams/update-team.md index 219989f0cd..afa84135a2 100644 --- a/docs/references/teams/update-team.md +++ b/docs/references/teams/update-team.md @@ -1 +1 @@ -Update team by its unique ID. Only team owners have write access for this resource. \ No newline at end of file +Update a team by its unique ID. Only team owners have write access for this resource. \ No newline at end of file diff --git a/docs/references/users/delete-user-session.md b/docs/references/users/delete-user-session.md index 7ce030a4a3..c207a78c53 100644 --- a/docs/references/users/delete-user-session.md +++ b/docs/references/users/delete-user-session.md @@ -1 +1 @@ -Delete user sessions by its unique ID. \ No newline at end of file +Delete a user sessions by its unique ID. \ No newline at end of file diff --git a/docs/references/users/delete-user-sessions.md b/docs/references/users/delete-user-sessions.md index 7c78dcd637..35375365d6 100644 --- a/docs/references/users/delete-user-sessions.md +++ b/docs/references/users/delete-user-sessions.md @@ -1 +1 @@ -Delete all user sessions by its unique ID. \ No newline at end of file +Delete all user's sessions by using the user's unique ID. \ No newline at end of file diff --git a/docs/references/users/get-user-logs.md b/docs/references/users/get-user-logs.md index e188651e80..b86d419a85 100644 --- a/docs/references/users/get-user-logs.md +++ b/docs/references/users/get-user-logs.md @@ -1 +1 @@ -Get user activity logs list by its unique ID. \ No newline at end of file +Get a user activity logs list by its unique ID. \ No newline at end of file diff --git a/docs/references/users/get-user-prefs.md b/docs/references/users/get-user-prefs.md index 0a704cfa34..d24a4f9608 100644 --- a/docs/references/users/get-user-prefs.md +++ b/docs/references/users/get-user-prefs.md @@ -1 +1 @@ -Get user preferences by its unique ID. \ No newline at end of file +Get the user preferences by its unique ID. \ No newline at end of file diff --git a/docs/references/users/get-user-sessions.md b/docs/references/users/get-user-sessions.md index acb9005302..844600e86b 100644 --- a/docs/references/users/get-user-sessions.md +++ b/docs/references/users/get-user-sessions.md @@ -1 +1 @@ -Get user sessions list by its unique ID. \ No newline at end of file +Get the user sessions list by its unique ID. \ No newline at end of file diff --git a/docs/references/users/get-user.md b/docs/references/users/get-user.md index 60cdf21cac..35d82f2a8a 100644 --- a/docs/references/users/get-user.md +++ b/docs/references/users/get-user.md @@ -1 +1 @@ -Get user by its unique ID. \ No newline at end of file +Get a user by its unique ID. \ No newline at end of file diff --git a/docs/references/users/list-users.md b/docs/references/users/list-users.md index fa7855bc22..76f1470119 100644 --- a/docs/references/users/list-users.md +++ b/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. \ No newline at end of file +Get a list of all the project's users. You can use the query params to filter your results. \ No newline at end of file diff --git a/docs/references/users/update-user-prefs.md b/docs/references/users/update-user-prefs.md index b61a54c6a6..cb06d4a7f3 100644 --- a/docs/references/users/update-user-prefs.md +++ b/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. \ No newline at end of file +Update the user preferences by its unique ID. You can pass only the specific settings you wish to update. \ No newline at end of file diff --git a/docs/references/users/update-user-status.md b/docs/references/users/update-user-status.md index fc334c322b..0eee46ec51 100644 --- a/docs/references/users/update-user-status.md +++ b/docs/references/users/update-user-status.md @@ -1 +1 @@ -Update user status by its unique ID. \ No newline at end of file +Update the user status by its unique ID. \ No newline at end of file