Skip to content
This repository has been archived by the owner on Mar 17, 2023. It is now read-only.

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

Merged
merged 3 commits into from
Dec 20, 2019
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions _data/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -478,6 +478,8 @@
- updateOwnBasicInfo
- Video Conference:
- jitsi-update-timeout
- Webdav:
- getMyAccounts
- Offset and Count and Sort Info
- Rate Limiter
- Query and Fields Info
Expand Down
2 changes: 2 additions & 0 deletions contributing/documentation/documentation-map/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -468,6 +468,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
Expand Down
6 changes: 6 additions & 0 deletions developer-guides/rest-api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -303,6 +303,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
Expand Down
5 changes: 5 additions & 0 deletions developer-guides/rest-api/webdav/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Webdav endpoints

| Url | Short Description | Details Page |
| :----------------------------------- | :------------------------------------------- | :-------------------- |
| `/api/v1/webdav.getMyAccounts` | Retrieves the user's webdav accounts. | [Link](getmyaccounts) |
37 changes: 37 additions & 0 deletions developer-guides/rest-api/webdav/getmyaccounts/README.md
Original file line number Diff line number Diff line change
@@ -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 |
| :--- | :--- |
| 3.0.0| Added |