forked from RocketChat/docs-old
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add docs to REST delete channels and groups (RocketChat#901)
- Loading branch information
1 parent
cf6949d
commit bd2755e
Showing
8 changed files
with
112 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| # Channel Delete | ||
|
|
||
| Remove a public channel. | ||
|
|
||
| | URL | Requires Auth | HTTP Method | | ||
| | :--- | :--- | :--- | | ||
| | `/api/v1/channels.delete` | `yes` | `POST` | | ||
|
|
||
| ## Payload | ||
|
|
||
| | Argument | Example | Required | Description | | ||
| | :--- | :--- | :--- | :--- | | ||
| | `roomId` | `ByehQjC44FwMeiLbX` | Required (if no roomName) | The channel's id | | ||
| | `roomName` | `general` | Required (if no roomId) | The channel's name | | ||
|
|
||
| ## Example Call | ||
|
|
||
| ```bash | ||
| curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \ | ||
| -H "X-User-Id: aobEdbYhXfu5hkeqG" \ | ||
| -H "Content-type: application/json" \ | ||
| http://localhost:3000/api/v1/channels.delete \ | ||
| -d '{ "roomName": "channelname" }' | ||
| ``` | ||
|
|
||
| ## Example Result | ||
|
|
||
| ```json | ||
| { | ||
| "channel": { | ||
| "_id": "ByehQjC44FwMeiLbX", | ||
| "name": "channelname", | ||
| "t": "c", | ||
| "usernames": [ | ||
| "example" | ||
| ], | ||
| "msgs": 0, | ||
| "u": { | ||
| "_id": "aobEdbYhXfu5hkeqG", | ||
| "username": "example" | ||
| }, | ||
| "ts": "2016-05-30T13:42:25.304Z" | ||
| }, | ||
| "success": true | ||
| } | ||
| ``` | ||
|
|
||
| ## Change Log | ||
|
|
||
| | Version | Description | | ||
| | :--- | :--- | | ||
| | 0.49.0 | Added | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| # Group Delete | ||
|
|
||
| Remove a private channel. | ||
|
|
||
| | URL | Requires Auth | HTTP Method | | ||
| | :--- | :--- | :--- | | ||
| | `/api/v1/groups.delete` | `yes` | `POST` | | ||
|
|
||
| ## Payload | ||
|
|
||
| | Argument | Example | Required | Description | | ||
| | :--- | :--- | :--- | :--- | | ||
| | `roomId` | `ByehQjC44FwMeiLbX` | Required (if no roomName) | The channel's id | | ||
| | `roomName` | `general` | Required (if no roomId) | The channel's name | | ||
|
|
||
| ## Example Call | ||
|
|
||
| ```bash | ||
| curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \ | ||
| -H "X-User-Id: aobEdbYhXfu5hkeqG" \ | ||
| -H "Content-type: application/json" \ | ||
| http://localhost:3000/api/v1/groups.delete \ | ||
| -d '{ "roomName": "channelname" }' | ||
| ``` | ||
|
|
||
| ## Example Result | ||
|
|
||
| ```json | ||
| { | ||
| "group": { | ||
| "_id": "ByehQjC44FwMeiLbX", | ||
| "name": "groupname", | ||
| "t": "c", | ||
| "usernames": [ | ||
| "example" | ||
| ], | ||
| "msgs": 0, | ||
| "u": { | ||
| "_id": "aobEdbYhXfu5hkeqG", | ||
| "username": "example" | ||
| }, | ||
| "ts": "2016-05-30T13:42:25.304Z" | ||
| }, | ||
| "success": true | ||
| } | ||
| ``` | ||
|
|
||
| ## Change Log | ||
|
|
||
| | Version | Description | | ||
| | :--- | :--- | | ||
| | 0.49.0 | Added | |