[NEW] Add docs for webdav's endpoint (#1528)

RocketChat · Dec 20, 2019 · e10cee7 · e10cee7
1 parent b8cc479
commit e10cee7
Show file tree

Hide file tree

Showing 5 changed files with 52 additions and 0 deletions.
diff --git a/_data/toc.yml b/_data/toc.yml
@@ -482,6 +482,8 @@
         - updateOwnBasicInfo
       - Video Conference:
         - jitsi-update-timeout
+      - Webdav:
+        - getMyAccounts
       - Offset and Count and Sort Info
       - Rate Limiter
       - Query and Fields Info

diff --git a/contributing/documentation/documentation-map/README.md b/contributing/documentation/documentation-map/README.md
@@ -472,6 +472,8 @@ Here you can also find what articles are incomplete and missing.
             - updateOwnBasicInfo
         - Video Conference:
             - jitsi-update-timeout
+        - Webdav:
+            - getMyAccounts
         - Offset and Count and Sort Info
         - Rate Limiter
         - Query and Fields Info

diff --git a/developer-guides/rest-api/README.md b/developer-guides/rest-api/README.md
@@ -311,6 +311,12 @@ When calling a production Rocket.Chat server, ensure it is running via HTTPS and
 | :----------------------------------------------- | :---------------------------------------------------------- | :-----------------------------------------     |
 | `/api/v1/video-conference/jitsi.update-timeout`  | Updates the timeout of Jitsi video conference in a channel. | [Link](video-conference/jitsi-update-timeout)  |
 
+### Webdav
+
+| Url                                  | Short Description                            | Details Page                   |
+| :----------------------------------- | :------------------------------------------- | :----------------------------  |
+| `/api/v1/webdav.getMyAccounts`       | Retrieves the user's webdav accounts.        | [Link](webdav/getmyaccounts)   |
+
 ## Language specific wrappers
 
 ### Java

diff --git a/developer-guides/rest-api/webdav/README.md b/developer-guides/rest-api/webdav/README.md
@@ -0,0 +1,5 @@
+# Webdav endpoints
+
+| Url                                  | Short Description                            | Details Page            |
+| :----------------------------------- | :------------------------------------------- | :--------------------   |
+| `/api/v1/webdav.getMyAccounts`       | Retrieves the user's webdav accounts.        | [Link](getmyaccounts)   |
diff --git a/developer-guides/rest-api/webdav/getmyaccounts/README.md b/developer-guides/rest-api/webdav/getmyaccounts/README.md
@@ -0,0 +1,37 @@
+# Webdav Get my Accounts
+
+Retrieves the user's webdav accounts.
+
+| URL | Requires Auth | HTTP Method |
+| :--- | :--- | :--- |
+| `/api/v1/webdav.getMyAccounts` | `yes` | `GET` |
+
+## Example call to get all the roles
+
+```bash
+curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
+     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
+     http://localhost:3000/api/v1/webdav.getMyAccounts
+```
+
+## Example Result
+
+```json
+{
+  "accounts": [
+    {
+      "_id": "P3Gru7ocFCd4vpKEs",
+      "server_url": "http://localhost:8080/remote.php/webdav/",
+      "username": "admin",
+      "name": "Webdav account"
+    }
+  ],
+  "success": true
+}
+```
+
+## Change Log
+
+| Version | Description |
+| :--- | :--- |
+| 2.4.0| Added |